Corect code style for main Python module. #2

Merged

mike merged 17 commits from bignose/ejabberd-auth-mastodon:wip/maintenance/code-style into master

2023-01-01 21:50:41 +11:00

bignose commented

2022-12-19 09:58:27 +11:00

Member

Improve code formatting and style to conform to PEP 8 specification.

bignose added 17 commits 2022-12-19 09:58:28 +11:00

de4e2027a1 Specify EditorConfig settings for this code base.

ebd066b170 Remove trailing whitespace.

c6c19a1bcf Convert indentation to use U+0020 SPACE characters.

PEP 8 specifies:

* Use 4 spaces per indentation level.

* Spaces (U+0008) are the preferred indentation method.

dc09a6be92 Normalise indentation levels by wrapping at open parenthesis.

PEP 8 specifies:

* Use 4 spaces per indentation level.

* Continuation lines should align wrapped elements either vertically using
  Python’s implicit line joining inside parentheses, brackets and braces,
  or using a hanging indent.

e30ab77cf4 Use structural blank lines conformant with PEP 8.

PEP 8 specifies:

* Surround top-level function and class definitions with two blank lines.

* Method definitions inside a class are surrounded by a single blank line.

3ef1d5daae Use a separate ‘import’ statement for each module/package, grouped.

PEP 8 specifies:

* Imports should usually be on separate lines.

* Imports are always put at the top of the file, just after any module
  comments and docstrings, and before module globals and constants.

* Imports should be grouped in the following order:

  * Standard library imports.
  * Related third party imports.
  * Local application/library specific imports.

512114517c Remove unused imports.

9a2d05e51f Use ‘# ’ comment leader for block comments.

PEP 8 specifies:

* Each line of a block comment starts with a # and a single space (unless
  it is indented text inside the comment).

237abe539a Use whitespace around operators in conformance with PEP 8.

PEP 8 specifies:

* A single space around binary operators (e.g. ‘=’ assignment, ‘%’
  modulus).

* No surrounding space around ‘=’ in keyword argument assignment for a
  function call.

34ab6489ba Reformat SQL statement for clarity and wrap the long line.

9325300e39 Wrap long statements across multiple lines.

PEP 8 specifies:

* Limit all lines to a maximum of 79 characters.

* The preferred way of wrapping long lines is by using Python’s implied
  line continuation inside parentheses, brackets and braces. Long lines can
  be broken over multiple lines by wrapping expressions in parentheses.
  These should be used in preference to using a backslash for line
  continuation.

a88f298e98 Wrap long block comment lines at 72 columns.

4bed400c7d Use equality operator for comparison to integer value.

7118641d78 Use identity operators for comparison to None singleton.

PEP 8 specifies:

* Comparisons to singletons like None should always be done with `is` or
  `is not`, never the equality operators.

6a4de62467 Remove an assignment to an unused name.

1ad357ba4a Specify the ‘Exception’ catch-all exception class, not a bare ‘except’.

PEP 8 specifies:

* When catching exceptions, mention specific exceptions whenever possible
  instead of using a bare `except:` clause […]

  A bare `except:` clause will catch `SystemExit` and `KeyboardInterrupt`
  exceptions, making it harder to interrupt a program with Control-C, and
  can disguise other problems. If you want to catch all exceptions that
  signal program errors, use `except Exception:` (bare except is equivalent
  to `except BaseException:`).

2a7e4fcd6e Remove a statement using a name that is never defined in scope.

The intention may have been to close the “current” database cursor; but
there is no reference to that at this point in the code.

mike merged commit c44e457fd0 into master

2023-01-01 21:50:41 +11:00

mike referenced this issue from a commit

2023-01-01 21:50:41 +11:00

Merge pull request 'Corect code style for main Python module.' (#2) from bignose/ejabberd-auth-mastodon:wip/maintenance/code-style into master

No reviewers

No Label

No Milestone

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: chinwag/ejabberd-auth-mastodon#2

No description provided.