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

pylint/flake8: paths_cli.compiling #59

Merged
merged 3 commits into from
Oct 31, 2021

Conversation

dwhswenson
Copy link
Member

@dwhswenson dwhswenson commented Oct 28, 2021

Now that my in-editor linter is working again, I went over the code in the compiling subpackage and cleaned up most of the things that registered as errors in pylint and flake8.

I also used this as an excuse to start writing up a more detailed style guide for OpenPathSampling projects. I plan to put it in the main OPS developer docs as part of OPS 2.0 (it is Python 3 specific). The document is basically a list of "here are common cases where we allow exceptions to flake8/pylint errors and warnings" (basically, some guidelines as to when, IMHO, consistency becomes foolish consistency.)

Doc being developed in a gist: https://gist.github.com/dwhswenson/1361b849866af98e7f8e6599810670b2

EDIT: also fixes an incorrect version requirement in CategoryPlugin, which will be part of v0.3 (not v0.4 as I originally thought).

@codecov
Copy link

codecov bot commented Oct 28, 2021

Codecov Report

Merging #59 (acc6be2) into main (f8ed965) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##              main       #59   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           45        45           
  Lines         1766      1764    -2     
=========================================
- Hits          1766      1764    -2     
Impacted Files Coverage Δ
paths_cli/compiling/errors.py 100.00% <ø> (ø)
paths_cli/compiling/networks.py 100.00% <ø> (ø)
paths_cli/compiling/plugins.py 100.00% <ø> (ø)
paths_cli/compiling/root_compiler.py 100.00% <ø> (ø)
paths_cli/compiling/schemes.py 100.00% <ø> (ø)
paths_cli/compiling/shooting.py 100.00% <ø> (ø)
paths_cli/compiling/strategies.py 100.00% <ø> (ø)
paths_cli/compiling/core.py 100.00% <100.00%> (ø)
paths_cli/compiling/cvs.py 100.00% <100.00%> (ø)
paths_cli/compiling/engines.py 100.00% <100.00%> (ø)
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f8ed965...acc6be2. Read the comment docs.

Copy link
Member

@sroet sroet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, 1 question about a code change that seems like it is a bugfix and should probably be documented somewhere

class CategoryPlugin(OPSPlugin):
"""
Category plugins only need to be made for top-level
"""
def __init__(self, plugin_class, aliases=None, requires_ops=(1, 0),
requires_cli=(0,4)):
requires_cli=(0, 3)):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems like an actual bugfix? should this be mentioned somewhere?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd argue that it isn't a bugfix on the basis that it isn't in released code. However, I edited the main post of this PR to make mention of the change.

@dwhswenson dwhswenson merged commit fe719e3 into openpathsampling:main Oct 31, 2021
@dwhswenson dwhswenson deleted the pylint-compiling branch October 31, 2021 11:15
@dwhswenson dwhswenson mentioned this pull request Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants