Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.gitignore and linting fixes #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Stealthii
Copy link
Contributor

A .gitignore has been added with commonly accepted paths to ignore for Python and Git projects.

General linting changes have been made for PEP8 - commit description contains more information.

Before:

************* Module doxieapi
doxieapi/__init__.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module doxieapi.api
doxieapi/api.py:79:0: C0301: Line too long (101/100) (line-too-long)
doxieapi/api.py:81:0: C0301: Line too long (114/100) (line-too-long)
doxieapi/api.py:145:0: C0301: Line too long (102/100) (line-too-long)
doxieapi/api.py:1:0: C0114: Missing module docstring (missing-module-docstring)
doxieapi/api.py:23:0: C0115: Missing class docstring (missing-class-docstring)
doxieapi/api.py:23:0: R0902: Too many instance attributes (9/7) (too-many-instance-attributes)
doxieapi/api.py:105:35: E1101: Instance of 'LookupDict' has no 'ok' member (no-member)
doxieapi/api.py:131:11: C0121: Comparison to True should be just 'expr' (singleton-comparison)
doxieapi/api.py:145:12: W0707: Consider explicitly re-raising using the 'from' keyword (raise-missing-from)
doxieapi/api.py:208:40: C0103: Variable name "f" doesn't conform to snake_case naming style (invalid-name)
doxieapi/api.py:242:39: E1101: Instance of 'LookupDict' has no 'no_content' member (no-member)
doxieapi/api.py:266:39: E1101: Instance of 'LookupDict' has no 'no_content' member (no-member)
************* Module doxieapi.__main__
doxieapi/__main__.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module doxieapi.ssdp
doxieapi/ssdp.py:1:0: C0114: Missing module docstring (missing-module-docstring)
doxieapi/ssdp.py:27:8: C0103: Attribute name "st" doesn't conform to snake_case naming style (invalid-name)
doxieapi/ssdp.py:21:0: C0115: Missing class docstring (missing-class-docstring)
doxieapi/ssdp.py:21:0: R0205: Class 'SSDPResponse' inherits from object, can be safely removed from bases in python3 (useless-object-inheritance)
doxieapi/ssdp.py:23:8: C0103: Variable name "r" doesn't conform to snake_case naming style (invalid-name)
doxieapi/ssdp.py:21:0: R0903: Too few public methods (1/2) (too-few-public-methods)
doxieapi/ssdp.py:32:0: C0103: Argument name "mx" doesn't conform to snake_case naming style (invalid-name)
doxieapi/ssdp.py:32:0: C0116: Missing function or method docstring (missing-function-docstring)

-----------------------------------
Your code has been rated at 7.98/10

After:

************* Module doxieapi.api
doxieapi/api.py:169:12: W0707: Consider explicitly re-raising using the 'from' keyword (raise-missing-from)
************* Module doxieapi.ssdp
doxieapi/ssdp.py:29:0: R0205: Class 'SSDPResponse' inherits from object, can be safely removed from bases in python3 (useless-object-inheritance)

------------------------------------------------------------------
Your code has been rated at 9.88/10 (previous run: 7.98/10, +1.91)

Other PyLint errors are already fixed in either #5 or #6.

Many linting improvements were made, and docstrings added where missing.
The requests library generates members within requests.codes, so
definitions for this were added for pylint.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant