Upd base #1
Merged
Upd base #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
By running Pylint before any of the unit tests (and dependency installs), the import-error check will always fail since the dependencies are not yet installed. We could move Pylint to a later stage to resolve this, but there's value in this quick check occurring before the unit tests. As a result, this Pylint check is being disabled.
add authentication info
* add functions, tests and doc for CodeCommit
Note that this commit also raises ValueErrors in situations that would previously have returned None. Per PEP8: Be consistent in return statements. Either all return statements in a function should return an expression, or none of them should. If any return statement returns an expression, any return statements where no value is returned should explicitly state this as return None, and an explicit return statement should be present at the end of the function (if reachable).
Note that this commit will also enable simplifiable-if-statement, as there are no code changes needed for it.
The logic behind this rule is to improve readability by defining all the attributes of a class inside the init function, even if it simply sets them to None.
Per PEP8: Imports should be grouped in the following order: 1- Standard library imports. 2- Related third party imports. 3- Local application/library specific imports.
* change: enable wrong-import-order Pylint check Per PEP8: Imports should be grouped in the following order: 1- Standard library imports. 2- Related third party imports. 3- Local application/library specific imports.
* change: enable consider-using-in Pylint check
* change: enable too-many-public-methods Pylint check This is a useful check to have, but is a lot of work to retroactively enforce. Enabling it while ignoring the single violation allows the validation to run for future code.
This commit will add an exclusion for all auto-generated files. I chose to ignore the single violation, because the alternative is confusingly convoluted: `(hasattr(obj, '__getitem__') if hasattr(obj, '__iter__') else isinstance(obj, str))`
The check recommendations are only valid for packages that exclusively support Python 3. The changes cannot be made in Python 2. The TODO was updated to clarify this.
This commit will format all existing docstring to follow Google style: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html This commit will also add docstring placeholders to any class or method previously missing it. An ideal approach would be to take the time to include meaningful docstrings in every file. However, since that is not a task that will be prioritized, I've declared docstring bankruptcy on this package, in order to enforce docstring on all future code changes to this package.
…er() with frameworks (#944)
[pr-827][followups] Improve documentation of some functions. Also some unit test fixes. See comments from marcio in #827
Added instructions that allow for a low-cost ~10min environment setup.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Merge Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.