diff --git a/.pylintrc b/.pylintrc index 1f7d977..3be18e5 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,637 +1,405 @@ -[MAIN] - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Clear in-memory caches upon conclusion of linting. Useful if running pylint -# in a server-like mode. -clear-cache-post-run=no - -# Load and enable all available extensions. Use --list-extensions to see a list -# all available extensions. -#enable-all-extensions= +# This Pylint rcfile contains a best-effort configuration to uphold the +# best-practices and style described in the Google Python style guide: +# https://google.github.io/styleguide/pyguide.html +# +# Its canonical open-source location is: +# https://google.github.io/styleguide/pylintrc -# In error mode, messages with a category besides ERROR or FATAL are -# suppressed, and no reports are done by default. Error mode is compatible with -# disabling specific errors. -#errors-only= - -# Always return a 0 (non-error) status code, even if lint errors are found. -# This is primarily useful in continuous integration scripts. -#exit-zero= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. -extension-pkg-allow-list= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. (This is an alternative name to extension-pkg-allow-list -# for backward compatibility.) -extension-pkg-whitelist= - -# Return non-zero exit code if any of these messages/categories are detected, -# even if score is above --fail-under value. Syntax same as enable. Messages -# specified are enabled, while categories only check already-enabled messages. -fail-on= - -# Specify a score threshold under which the program will exit with error. -fail-under=10 - -# Interpret the stdin as a python script, whose filename needs to be passed as -# the module_or_package argument. -#from-stdin= +[MAIN] # Files or directories to be skipped. They should be base names, not paths. -ignore=CVS - -# Add files or directories matching the regular expressions patterns to the -# ignore-list. The regex matches against paths and can be in Posix or Windows -# format. Because '\\' represents the directory delimiter on Windows systems, -# it can't be used as an escape character. -ignore-paths=tests +ignore=third_party -# Files or directories matching the regular expression patterns are skipped. -# The regex matches against base names, not paths. The default value ignores -# Emacs file locks -ignore-patterns=^\.# +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis). It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the -# number of processors available to use, and will cap the count on Windows to -# avoid hangs. -jobs=1 - -# Control the amount of potential inferred values when inferring a single -# object. This can help the performance when dealing with large functions or -# complex, nested conditions. -limit-inference-results=100 +# Pickle collected data for later comparisons. +persistent=no -# List of plugins (as comma separated values of python module names) to load, +# List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. load-plugins= -# Pickle collected data for later comparisons. -persistent=yes - -# Minimum Python version to use for version dependent checks. Will default to -# the version used to run pylint. -py-version=3.10 - -# Discover python modules and packages in the file system subtree. -recursive=no - -# Add paths to the list of the source roots. Supports globbing patterns. The -# source root is an absolute path or a path relative to the current working -# directory used to determine a package namespace for modules located under the -# source root. -source-roots= - -# When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages. -suggestion-mode=yes +# Use multiple processes to speed up Pylint. +jobs=4 # Allow loading of arbitrary C extensions. Extensions are imported into the # active Python interpreter and may run arbitrary code. unsafe-load-any-extension=no -# In verbose mode, extra non-checker-related info will be displayed. -#verbose= - - -[BASIC] - -# Naming style matching correct argument names. -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# naming-style. If left empty, argument names will be checked with the set -# naming style. -#argument-rgx= - -# Naming style matching correct attribute names. -attr-naming-style=snake_case - -# Regular expression matching correct attribute names. Overrides attr-naming- -# style. If left empty, attribute names will be checked with the set naming -# style. -#attr-rgx= - -# Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata - -# Bad variable names regexes, separated by a comma. If names match any regex, -# they will always be refused -bad-names-rgxs= - -# Naming style matching correct class attribute names. -class-attribute-naming-style=any - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. If left empty, class attribute names will be checked -# with the set naming style. -#class-attribute-rgx= -# Naming style matching correct class constant names. -class-const-naming-style=UPPER_CASE - -# Regular expression matching correct class constant names. Overrides class- -# const-naming-style. If left empty, class constant names will be checked with -# the set naming style. -#class-const-rgx= - -# Naming style matching correct class names. -class-naming-style=PascalCase - -# Regular expression matching correct class names. Overrides class-naming- -# style. If left empty, class names will be checked with the set naming style. -#class-rgx= - -# Naming style matching correct constant names. -const-naming-style=UPPER_CASE +[MESSAGES CONTROL] -# Regular expression matching correct constant names. Overrides const-naming- -# style. If left empty, constant names will be checked with the set naming -# style. -#const-rgx= +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +#enable= -# Naming style matching correct function names. -function-naming-style=snake_case +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +disable=R, + abstract-method, + apply-builtin, + arguments-differ, + attribute-defined-outside-init, + backtick, + bad-option-value, + basestring-builtin, + broad-exception-caught, + buffer-builtin, + c-extension-no-member, + consider-using-enumerate, + cmp-builtin, + cmp-method, + coerce-builtin, + coerce-method, + delslice-method, + div-method, + eq-without-hash, + execfile-builtin, + file-builtin, + filter-builtin-not-iterating, + fixme, + getslice-method, + global-statement, + hex-method, + idiv-method, + implicit-str-concat, + import-error, + import-self, + import-star-module-level, + input-builtin, + intern-builtin, + invalid-str-codec, + isinstance-second-argument-not-valid-type, + line-too-long, + locally-disabled, + long-builtin, + long-suffix, + map-builtin-not-iterating, + misplaced-comparison-constant, + missing-class-docstring, + missing-function-docstring, + missing-module-docstring, + metaclass-assignment, + next-method-called, + next-method-defined, + no-absolute-import, + no-init, # added + no-member, + no-name-in-module, + no-self-use, + nonzero-method, + oct-method, + old-division, + old-ne-operator, + old-octal-literal, + old-raise-syntax, + parameter-unpacking, + possibly-unused-variable, + print-statement, + raising-string, + range-builtin-not-iterating, + raw_input-builtin, + rdiv-method, + reduce-builtin, + relative-import, + reload-builtin, + round-builtin, + setslice-method, + signature-differs, + standarderror-builtin, + suppressed-message, + sys-max-int, + trailing-newlines, + unichr-builtin, + unicode-builtin, + unnecessary-pass, + unpacking-in-except, + useless-else-on-loop, + useless-suppression, + using-cmp-argument, + wrong-import-order, + xrange-builtin, + zip-builtin-not-iterating, -# Regular expression matching correct function names. Overrides function- -# naming-style. If left empty, function names will be checked with the set -# naming style. -#function-rgx= -# Good variable names which should always be accepted, separated by a comma. -good-names=i, - j, - k, - ex, - Run, - _ +[REPORTS] -# Good variable names regexes, separated by a comma. If names match any regex, -# they will always be accepted -good-names-rgxs= +# Set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html. You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text -# Include a hint for the correct naming format with invalid-name. -include-naming-hint=no +# Tells whether to display a full report or only the messages +reports=no -# Naming style matching correct inline iteration names. -inlinevar-naming-style=any +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style. If left empty, inline iteration names will be checked -# with the set naming style. -#inlinevar-rgx= +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= -# Naming style matching correct method names. -method-naming-style=snake_case -# Regular expression matching correct method names. Overrides method-naming- -# style. If left empty, method names will be checked with the set naming style. -#method-rgx= +[BASIC] -# Naming style matching correct module names. -module-naming-style=snake_case +# Good variable names which should always be accepted, separated by a comma +good-names=main,_ -# Regular expression matching correct module names. Overrides module-naming- -# style. If left empty, module names will be checked with the set naming style. -#module-rgx= +# Bad variable names which should always be refused, separated by a comma +bad-names= # Colon-delimited sets of names that determine each other's naming style when # the name regexes allow several styles. name-group= -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no # List of decorators that produce properties, such as abc.abstractproperty. Add # to this list to register other decorators that produce valid properties. -# These decorators are taken in consideration only for invalid-name. -property-classes=abc.abstractproperty - -# Regular expression matching correct type alias names. If left empty, type -# alias names will be checked with the set naming style. -#typealias-rgx= - -# Regular expression matching correct type variable names. If left empty, type -# variable names will be checked with the set naming style. -#typevar-rgx= - -# Naming style matching correct variable names. -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style. If left empty, variable names will be checked with the set -# naming style. -#variable-rgx= - - -[CLASSES] - -# Warn about protected attribute access inside special methods -check-protected-access-in-special-methods=no +property-classes=abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - asyncSetUp, - __post_init__ - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls +# Regular expression matching correct function names +function-rgx=^(?:(?PsetUp|tearDown|setUpModule|tearDownModule)|(?P_?[A-Z][a-zA-Z0-9]*)|(?P_?[a-z][a-z0-9_]*))$ -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs +# Regular expression matching correct variable names +variable-rgx=^_?[a-z][a-z0-9_]*$ +# Regular expression matching correct constant names +const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ -[DESIGN] +# Regular expression matching correct attribute names +attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ -# List of regular expressions of class ancestor names to ignore when counting -# public methods (see R0903) -exclude-too-few-public-methods= +# Regular expression matching correct argument names +argument-rgx=^_?[a-z][a-z0-9_]*$ -# List of qualified class names to ignore when counting class parents (see -# R0901) -ignored-parents= +# Regular expression matching correct class attribute names +class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ -# Maximum number of arguments for function / method. -max-args=5 +# Regular expression matching correct inline iteration names +inlinevar-rgx=^[a-z][a-z0-9_]*$ -# Maximum number of attributes for a class (see R0902). -max-attributes=7 +# Regular expression matching correct class names +class-rgx=^_?[A-Z][a-zA-Z0-9]*$ -# Maximum number of boolean expressions in an if statement (see R0916). -max-bool-expr=5 +# Regular expression matching correct module names +module-rgx=^(_?[a-z][a-z0-9_]*|__init__)$ -# Maximum number of branch for function / method body. -max-branches=12 +# Regular expression matching correct method names +method-rgx=(?x)^(?:(?P_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P_{0,2}[a-z][a-z0-9_]*))$ -# Maximum number of locals for function / method body. -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=(__.*__|main|test.*|.*test|.*Test)$ -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=12 -# Maximum number of return / yield for function / method body. -max-returns=6 -# Maximum number of statements in function / method body. -max-statements=50 +[TYPECHECK] -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= -[EXCEPTIONS] +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local -# Exceptions that will emit a warning when caught. -overgeneral-exceptions=builtins.BaseException,builtins.Exception +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= [FORMAT] -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - # Maximum number of characters on a single line. -max-line-length=100 +max-line-length=88 -# Maximum number of lines in a module. -max-module-lines=1000 +# TODO(https://github.com/pylint-dev/pylint/issues/3352): Direct pylint to exempt +# lines made too long by directives to pytype. -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=(?x)( + ^\s*(\#\ )??$| + ^\s*(from\s+\S+\s+)?import\s+.+$) # Allow the body of an if to be on the same line as the test if there is no # else. -single-line-if-stmt=no +single-line-if-stmt=yes +# Maximum number of lines in a module +max-module-lines=99999 -[IMPORTS] - -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= - -# Allow explicit reexports by alias from a package __init__. -allow-reexport-from-package=no - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Deprecated modules which should not be used, separated by a comma. -deprecated-modules= - -# Output a graph (.gv or any supported image format) of external dependencies -# to the given file (report RP0402 must not be disabled). -ext-import-graph= - -# Output a graph (.gv or any supported image format) of all (i.e. internal and -# external) dependencies to the given file (report RP0402 must not be -# disabled). -import-graph= - -# Output a graph (.gv or any supported image format) of internal dependencies -# to the given file (report RP0402 must not be disabled). -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - -# Couples of modules and preferred modules, separated by a comma. -preferred-modules= - - -[LOGGING] - -# The type of string formatting that logging methods do. `old` means using % -# formatting, `new` is for `{}` formatting. -logging-format-style=old - -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, -# UNDEFINED. -confidence=HIGH, - CONTROL_FLOW, - INFERENCE, - INFERENCE_FAILURE, - UNDEFINED - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once). You can also use "--disable=all" to -# disable everything first and then re-enable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use "--disable=all --enable=classes -# --disable=W". -disable=raw-checker-failed, - bad-inline-option, - locally-disabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - use-symbolic-message-instead, - missing-class-docstring, - missing-module-docstring, - missing-function-docstring, - too-many-instance-attributes, - broad-exception-raised, - useless-parent-delegation - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable=c-extension-no-member - +# String used as indentation unit. The internal Google style guide mandates 2 +# spaces. Google's externaly-published style guide says 4, consistent with +# PEP 8. Here, we use 2 spaces, for conformity with many open-sourced Google +# projects (like TensorFlow). +indent-string=' ' -[METHOD_ARGS] +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 -# List of qualified names (i.e., library.method) which require a timeout -# parameter e.g. 'requests.api.get,requests.api.post' -timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO +notes=TODO + -# Regular expression of note tags to take in consideration. -notes-rgx= +[STRING] +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=yes -[REFACTORING] -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 +[VARIABLES] -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=sys.exit,argparse.parse_error +# Tells whether we should check for unused import in __init__ files. +init-import=no +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) -[REPORTS] +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= -# Python expression which should return a score less than or equal to 10. You -# have access to the variables 'fatal', 'error', 'warning', 'refactor', -# 'convention', and 'info' which contain the number of messages in each -# category, as well as 'statement' which is the total number of statements -# analyzed. This score is used by the global evaluation report (RP0004). -evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details. -msg-template= +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six,six.moves,past.builtins,future.builtins,functools -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -#output-format= -# Tells whether to display a full report or only the messages. -reports=no +[LOGGING] -# Activate the evaluation score. -score=yes +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging,absl.logging,tensorflow.io.logging [SIMILARITIES] -# Comments are removed from the similarity computation +# Minimum lines number of a similarity. +min-similarity-lines=4 + +# Ignore comments when computing similarities. ignore-comments=yes -# Docstrings are removed from the similarity computation +# Ignore docstrings when computing similarities. ignore-docstrings=yes -# Imports are removed from the similarity computation -ignore-imports=yes - -# Signatures are removed from the similarity computation -ignore-signatures=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 +# Ignore imports when computing similarities. +ignore-imports=no [SPELLING] -# Limits count of emitted suggestions for spelling mistakes. -max-spelling-suggestions=4 - -# Spelling dictionary name. No available dictionaries : You need to install -# both the python package and the system dependency for enchant to work.. +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. spelling-dict= -# List of comma separated words that should be considered directives if they -# appear at the beginning of a comment and should not be checked. -spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: - # List of comma separated words that should not be checked. spelling-ignore-words= -# A path to a file that contains the private dictionary; one word per line. +# A path to a file that contains private dictionary; one word per line. spelling-private-dict-file= -# Tells whether to store unknown words to the private dictionary (see the -# --spelling-private-dict-file option) instead of raising a message. +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. spelling-store-unknown-words=no -[STRING] - -# This flag controls whether inconsistent-quotes generates a warning when the -# character used as a quote delimiter is used inconsistently within a module. -check-quote-consistency=no - -# This flag controls whether the implicit-str-concat should generate a warning -# on implicit string concatenation in sequences defined over several lines. -check-str-concat-over-line-jumps=no - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether to warn about missing members when the owner of the attribute -# is inferred to be None. -ignore-none=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of symbolic message names to ignore for Mixin members. -ignored-checks-for-mixins=no-member, - not-async-context-manager, - not-context-manager, - attribute-defined-outside-init - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 +[IMPORTS] -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub, + TERMIOS, + Bastion, + rexec, + sets -# Regex pattern to define which classes are considered mixins. -mixin-class-rgx=.*[Mm]ixin +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= -# List of decorators that change the signature of a decorated function. -signature-mutators= +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= -[VARIABLES] +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid defining new builtins when possible. -additional-builtins= +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant, absl -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no -# List of names allowed to shadow builtins -allowed-redefined-builtins= -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_, - _cb +[CLASSES] -# A regular expression matching the name of dummy variables (i.e. expected to -# not be used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp -# Argument names that match this expression will be ignored. -ignored-argument-names=_.*|^ignored_|^unused_ +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make -# Tells whether we should check for unused import in __init__ files. -init-import=no +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls, + class_ -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..1492485 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "python.terminal.launchArgs": [ + + ], + "pylint.importStrategy": "useBundled" +} diff --git a/Makefile b/Makefile index 1ef91e3..337d921 100644 --- a/Makefile +++ b/Makefile @@ -1,35 +1,37 @@ -MONEYWIZ_DB_PATH?="/Users/$(shell whoami)/Library/Containers/com.moneywiz.personalfinance/Data/Documents/.AppData/ipadMoneyWiz.sqlite" +VENV?=${VIRTUAL_ENV} +PYTHONPATH=./src -.venv/bin/activate: - python3.10 -m venv .venv -venv: .venv/bin/activate +${VENV}/bin/activate: + python3.10 -m venv ${VENV} + +venv: ${VENV}/bin/activate install: requirements.txt requirements-dev.txt venv - .venv/bin/pip3 install -r requirements.txt - .venv/bin/pip3 install -r requirements-dev.txt + ${VENV}/bin/pip3 install -r requirements.txt + ${VENV}/bin/pip3 install -r requirements-dev.txt test: - .venv/bin/python -m pytest tests + ${VENV}/bin/python -m pytest tests pylint: - .venv/bin/python -m pylint --rcfile .pylintrc src + ${VENV}/bin/python -m pylint --rcfile .pylintrc src mypy: - .venv/bin/python -m mypy src + ${VENV}/bin/python -m mypy src format: - .venv/bin/python -m black -l 88 src tests + ${VENV}/bin/python -m black -l 88 src tests shell: - .venv/bin/python src/shell.py ${MONEYWIZ_DB_PATH} + ${VENV}/bin/python src/moneywiz_api/cli/cli.py package: - .venv/bin/python -m build + ${VENV}/bin/python -m build test-publish: - .venv/bin/python -m twine upload --repository testpypi dist/* + ${VENV}/bin/python -m twine upload --repository testpypi dist/* publish: - .venv/bin/python -m twine upload --repository pypi dist/* + ${VENV}/bin/python -m twine upload --repository pypi dist/* diff --git a/pyproject.toml b/pyproject.toml index 3ccfb14..5905650 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,14 @@ classifiers = [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {dev = { file = ["requirements-dev.txt"] }} + +[project.scripts] +moneywiz-cli = "moneywiz_api.cli.cli:main" [project.urls] "Homepage" = "https://github.com/ileodo/moneywiz-api" diff --git a/src/moneywiz_api/cli/cli.py b/src/moneywiz_api/cli/cli.py new file mode 100644 index 0000000..0974479 --- /dev/null +++ b/src/moneywiz_api/cli/cli.py @@ -0,0 +1,93 @@ +from os.path import expanduser +from pathlib import Path +from code import interact +from typing import Dict, List + +import click +import logging + +from moneywiz_api.cli.helpers import ShellHelper +from moneywiz_api.moneywiz_api import MoneywizApi + + +def get_default_path() -> Path: + return Path( + expanduser( + "~/Library/Containers/com.moneywiz.personalfinance/Data/Documents/.AppData/ipadMoneyWiz.sqlite" + ) + ) + + +@click.command() +@click.argument( + "DB_FILE_PATH", + type=click.Path(writable=False, readable=True, exists=True), + default=get_default_path(), +) +@click.option( + "--log-level", + default="INFO", + type=click.Choice( + ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], case_sensitive=False + ), + help="Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)", +) +def main(db_file_path, log_level): + """ + Interactive shell to access MoneyWiz (Read-only) + """ + + # Configure logging level + numeric_level = getattr(logging, log_level.upper(), None) + if not isinstance(numeric_level, int): + raise ValueError(f"Invalid log level: {log_level}") + + logging.basicConfig(level=numeric_level) + + root_logger = logging.getLogger() + root_logger.setLevel(numeric_level) + + moneywiz_api = MoneywizApi(db_file_path) + + ( + accessor, + account_manager, + payee_manager, + category_manager, + transaction_manager, + investment_holding_manager, + ) = ( + moneywiz_api.accessor, + moneywiz_api.account_manager, + moneywiz_api.payee_manager, + moneywiz_api.category_manager, + moneywiz_api.transaction_manager, + moneywiz_api.investment_holding_manager, + ) + + helper = ShellHelper(moneywiz_api) + + names: Dict[str, str] = { + f"{moneywiz_api=}".split("=")[0]: "MoneyWiz API", + f"{accessor=}".split("=")[0]: "MoneyWiz Database Accessor", + f"{account_manager=}".split("=")[0]: "Account Manager", + f"{payee_manager=}".split("=")[0]: "Payee Manager", + f"{category_manager=}".split("=")[0]: "Category Manageer", + f"{transaction_manager=}".split("=")[0]: "Transaction Manager", + f"{investment_holding_manager=}".split("=")[0]: "Investment Holding Manager", + f"{helper=}".split("=")[0]: "Shell Helper", + } + + banner: List[str] = ( + f"Read-only MoneyWiz Shell on {db_file_path}", + "", + "Avaliable components:", + *[f"- {component:30} {desc}" for component, desc in names.items()], + "===================================================================", + ) + + interact(local=locals(), banner="\n".join(banner)) + + +if __name__ == "__main__": + main() # pylint: disable=no-value-for-parameter diff --git a/src/moneywiz_api/cli/helpers.py b/src/moneywiz_api/cli/helpers.py new file mode 100644 index 0000000..1716f27 --- /dev/null +++ b/src/moneywiz_api/cli/helpers.py @@ -0,0 +1,84 @@ +from dataclasses import asdict +from typing import Dict + +import logging +import pathlib +import json +import click +import pandas as pd + +from moneywiz_api import MoneywizApi +from moneywiz_api.types import ID + + +logger = logging.getLogger(__name__) + + +class ShellHelper: + + def __init__(self, moneywiz_api: MoneywizApi) -> None: + self._mw_api = moneywiz_api + + def view_id(self, record_id: ID): + record = self._mw_api.accessor.get_record(record_id) + click.echo(self._mw_api.accessor.typename_for(record.ent())) + click.echo(json.dumps(record.filtered(), sort_keys=True, indent=4)) + + def print_investment_holdings_for_account(self, account_id: ID): + for x in [ + f"{h.id}: 0, #{h.symbol}" + for h in self._mw_api.investment_holding_manager.get_holdings_for_account( + account_id + ) + ]: + print(x) + + def write_state_data_files(self): + path_prefix = "data/state" + pathlib.Path(path_prefix).mkdir(parents=True, exist_ok=True) + managers_map: Dict[str, object] = { + "ent": self._mw_api.accessor, + "account": self._mw_api.account_manager, + "payee": self._mw_api.payee_manager, + "category": self._mw_api.category_manager, + "transaction": self._mw_api.transaction_manager, + "investment_holding": self._mw_api.investment_holding_manager, + } + + for name, obj in managers_map.items(): + with open(f"{path_prefix}/{name}.data", "w", encoding="utf-8") as file: + print(obj, file=file) + + def account_tables(self, user_id: ID): + pd.set_option("display.max_colwidth", None) + pd.set_option("display.max_rows", None) + + accounts = self._mw_api.account_manager.get_accounts_for_user(user_id) + + df = pd.DataFrame.from_records([asdict(account) for account in accounts]) + print( + df.sort_values(by=["_group_id", "_display_order"])[ + ["id", "name"] + ].to_string(index=False) + ) + + def transactions_for_account(self, account_id: ID): + records = self._mw_api.transaction_manager.get_all_for_account(account_id) + + df = pd.DataFrame.from_records([asdict(record) for record in records]) + print( + df.sort_values(by=["date"], ascending=False)[ + ["id", "date", "amount"] + ].to_string(index=False) + ) + + print("total_amount:", df["amount"].sum()) + print("number of transactions:", df.shape[0]) + + def generate_categories_list(self, user_id: ID): + categories = self._mw_api.category_manager.get_categories_for_user(user_id) + + for category in categories: + print( + f"""{category.id}: ["{category.type}", {", ".join(['"'+ x.replace(" ","") + '"' for x in category_manager.get_name_chain(category.id)])}],""" + ) diff --git a/src/shell.py b/src/shell.py deleted file mode 100644 index 4893ea1..0000000 --- a/src/shell.py +++ /dev/null @@ -1,116 +0,0 @@ -import sys, os - -print(sys.path) -print(os.environ["PYTHONPATH"]) - -import pathlib -import sys -from dataclasses import asdict -from pathlib import Path -from typing import Dict -import logging -import json -import code -import pandas as pd - -from moneywiz_api import MoneywizApi -from moneywiz_api.types import ID - -logging.basicConfig(level=logging.DEBUG) - -logger = logging.getLogger(__name__) - -DB_PATH = sys.argv[1] - -moneywizApi = MoneywizApi(Path(DB_PATH)) - -( - accessor, - account_manager, - payee_manager, - category_manager, - transaction_manager, - investment_holding_manager, - tag_manager, -) = ( - moneywizApi.accessor, - moneywizApi.account_manager, - moneywizApi.payee_manager, - moneywizApi.category_manager, - moneywizApi.transaction_manager, - moneywizApi.investment_holding_manager, - moneywizApi.tag_manager, -) - - -def view(record_id: ID): - record = accessor.get_record(record_id) - print(accessor.typename_for(record.ent())) - print(json.dumps(record.filtered(), sort_keys=True, indent=4)) - - -def print_investment_holdings_for_account(account_id: ID): - for x in [ - f"{h.id}: 0, #{h.symbol}" - for h in investment_holding_manager.get_holdings_for_account(account_id) - ]: - print(x) - - -def write_state_data_files(): - path_prefix = "data/state" - pathlib.Path(path_prefix).mkdir(parents=True, exist_ok=True) - managers_map: Dict[str, object] = { - "ent": accessor, - "account": account_manager, - "payee": payee_manager, - "category": category_manager, - "transaction": transaction_manager, - "investment_holding": investment_holding_manager, - } - - for name, obj in managers_map.items(): - with open(f"{path_prefix}/{name}.data", "w") as file: - print(obj, file=file) - - -def account_tables(user_id: ID): - pd.set_option("display.max_colwidth", None) - pd.set_option("display.max_rows", None) - - accounts = account_manager.get_accounts_for_user(user_id) - - df = pd.DataFrame.from_records([asdict(account) for account in accounts]) - print( - df.sort_values(by=["_group_id", "_display_order"])[["id", "name"]].to_string( - index=False - ) - ) - - -def transactions_for_account(account_id: ID): - records = transaction_manager.get_all_for_account(account_id) - - df = pd.DataFrame.from_records([asdict(record) for record in records]) - print( - df.sort_values(by=["date"], ascending=False)[ - ["id", "date", "amount"] - ].to_string(index=False) - ) - - print("total_amount:", df["amount"].sum()) - print("number of transactions:", df.shape[0]) - - -def generate_categories_list(user_id: ID): - categories = category_manager.get_categories_for_user(user_id) - - for category in categories: - print( - f"""{category.id}: ["{category.type}", {", ".join(['"'+ x.replace(" ","") + '"' for x in category_manager.get_name_chain(category.id)])}],""" - ) - - -if __name__ == "__main__": - print("Shell on:" + DB_PATH) - code.interact(local=locals())