diff --git a/.gitignore b/.gitignore index 25837d1..3688468 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +venv/ # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/.pylintrc b/.pylintrc index 924c6f9..9078b89 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,195 +1,135 @@ -[MASTER] +[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= + +# 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 +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not -# paths. +# 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= + +# Files or directories to be skipped. They should be base names, not paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= +# 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= + +# 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=^\.# + +# 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. +# 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 -# List of plugins (as comma separated values of python modules names) to load, +# 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 + +# List of plugins (as comma separated values of python module names) to load, # usually to register additional checkers. load-plugins= # Pickle collected data for later comparisons. persistent=yes -# Specify a configuration file. -#rcfile= +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.11 + +# 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 +# user-friendly hints instead of false-positive error messages. suggestion-mode=yes # Allow loading of arbitrary C extensions. Extensions are imported into the # active Python interpreter and may run arbitrary code. unsafe-load-any-extension=no - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# 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=missing-docstring, - print-statement, - parameter-unpacking, - unpacking-in-except, - old-raise-syntax, - backtick, - long-suffix, - old-ne-operator, - old-octal-literal, - import-star-module-level, - non-ascii-bytes-literal, - raw-checker-failed, - bad-inline-option, - locally-disabled, - locally-enabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - apply-builtin, - basestring-builtin, - buffer-builtin, - cmp-builtin, - coerce-builtin, - execfile-builtin, - file-builtin, - long-builtin, - raw_input-builtin, - reduce-builtin, - standarderror-builtin, - unicode-builtin, - xrange-builtin, - coerce-method, - delslice-method, - getslice-method, - setslice-method, - no-absolute-import, - old-division, - dict-iter-method, - dict-view-method, - next-method-called, - metaclass-assignment, - indexing-exception, - raising-string, - reload-builtin, - oct-method, - hex-method, - nonzero-method, - cmp-method, - input-builtin, - round-builtin, - intern-builtin, - unichr-builtin, - map-builtin-not-iterating, - zip-builtin-not-iterating, - range-builtin-not-iterating, - filter-builtin-not-iterating, - using-cmp-argument, - eq-without-hash, - div-method, - idiv-method, - rdiv-method, - exception-message-attribute, - invalid-str-codec, - sys-max-int, - bad-python3-import, - deprecated-string-function, - deprecated-str-translate-call, - deprecated-itertools-function, - deprecated-types-field, - next-method-defined, - dict-items-not-iterating, - dict-keys-not-iterating, - dict-values-not-iterating - -# 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 - - -[REPORTS] - -# 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) - -# 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= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=colorized - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - -# 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=optparse.Values,sys.exit +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= [BASIC] -# Naming style matching correct argument names +# Naming style matching correct argument names. argument-naming-style=snake_case # Regular expression matching correct argument names. Overrides argument- -# naming-style +# naming-style. If left empty, argument names will be checked with the set +# naming style. #argument-rgx= -# Naming style matching correct attribute names +# Naming style matching correct attribute names. attr-naming-style=snake_case # Regular expression matching correct attribute names. Overrides attr-naming- -# style +# 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 variable names which should always be refused, separated by a comma. bad-names=foo, bar, baz, @@ -197,38 +137,54 @@ bad-names=foo, tutu, tata -# Naming style matching correct class attribute names +# 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 +# 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 names +# 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 +# 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 +# Naming style matching correct constant names. const-naming-style=UPPER_CASE # Regular expression matching correct constant names. Overrides const-naming- -# style +# style. If left empty, constant names will be checked with the set naming +# style. #const-rgx= # Minimum line length for functions/classes that require docstrings, shorter # ones are exempt. docstring-min-length=-1 -# Naming style matching correct function names +# Naming style matching correct function names. function-naming-style=snake_case # Regular expression matching correct function names. Overrides function- -# naming-style +# 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 variable names which should always be accepted, separated by a comma. good-names=i, j, k, @@ -236,28 +192,33 @@ good-names=i, Run, _ -# Include a hint for the correct naming format with invalid-name +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. include-naming-hint=no -# Naming style matching correct inline iteration names +# Naming style matching correct inline iteration names. inlinevar-naming-style=any # Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. #inlinevar-rgx= -# Naming style matching correct method names +# Naming style matching correct method names. method-naming-style=snake_case # Regular expression matching correct method names. Overrides method-naming- -# style +# style. If left empty, method names will be checked with the set naming style. #method-rgx= -# Naming style matching correct module names +# Naming style matching correct module names. module-naming-style=snake_case # Regular expression matching correct module names. Overrides module-naming- -# style +# style. If left empty, module names will be checked with the set naming style. #module-rgx= # Colon-delimited sets of names that determine each other's naming style when @@ -270,134 +231,94 @@ no-docstring-rgx=^_ # 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 -# Naming style matching correct variable names +# 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 +# naming-style. If left empty, variable names will be checked with the set +# naming style. #variable-rgx= -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# 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 - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins - +[CLASSES] -[TYPECHECK] +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no -# 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= +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit -# 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 valid names for the first argument in a class method. +valid-classmethod-first-arg=cls -# 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 +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs -# 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= -# 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 +[DESIGN] -# 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 +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= -# 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 +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= +# Maximum number of arguments for function / method. +max-args=5 -[SIMILARITIES] +# Maximum number of attributes for a class (see R0902). +max-attributes=7 -# Ignore comments when computing similarities. -ignore-comments=yes +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 -# Ignore docstrings when computing similarities. -ignore-docstrings=yes +# Maximum number of branch for function / method body. +max-branches=12 -# Ignore imports when computing similarities. -ignore-imports=no +# Maximum number of locals for function / method body. +max-locals=15 -# Minimum lines number of a similarity. -min-similarity-lines=4 +# Maximum number of parents for a class (see R0901). +max-parents=7 +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 -[SPELLING] +# Maximum number of return / yield for function / method body. +max-returns=6 -# Limits count of emitted suggestions for spelling mistakes -max-spelling-suggestions=4 +# Maximum number of statements in function / method body. +max-statements=50 -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 -# List of comma separated words that should not be checked. -spelling-ignore-words= -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= +[EXCEPTIONS] -# 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 +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception [FORMAT] @@ -408,7 +329,7 @@ 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. +# 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 @@ -418,16 +339,9 @@ indent-string=' ' # Maximum number of characters on a single line. max-line-length=100 -# Maximum number of lines in a module +# Maximum number of lines in a module. max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma, - dict-separator - # 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 @@ -437,6 +351,99 @@ single-line-class-stmt=no single-line-if-stmt=no +[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 + +# 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 + + +[METHOD_ARGS] + +# 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 + + [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. @@ -444,100 +451,181 @@ notes=FIXME, XXX, TODO +# Regular expression of note tags to take in consideration. +notes-rgx= -[CLASSES] -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp +[REFACTORING] -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict, - _fields, - _replace, - _source, - _make +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls +# 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 -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs +[REPORTS] -[DESIGN] +# 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)) -# Maximum number of arguments for function / method -max-args=5 +# 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= -# Maximum number of attributes for a class (see R0902). -max-attributes=7 +# 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= -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 +# Tells whether to display a full report or only the messages. +reports=no -# Maximum number of branch for function / method body -max-branches=12 +# Activate the evaluation score. +score=yes -# Maximum number of locals for function / method body -max-locals=15 -# Maximum number of parents for a class (see R0901). -max-parents=7 +[SIMILARITIES] -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 +# Comments are removed from the similarity computation +ignore-comments=yes -# Maximum number of return / yield for function / method body -max-returns=6 +# Docstrings are removed from the similarity computation +ignore-docstrings=yes -# Maximum number of statements in function / method body -max-statements=50 +# Imports are removed from the similarity computation +ignore-imports=yes -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 +# Signatures are removed from the similarity computation +ignore-signatures=yes +# Minimum lines number of a similarity. +min-similarity-lines=4 -[IMPORTS] -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no +[SPELLING] -# 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 +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=regsub, - TERMIOS, - Bastion, - rexec +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work.. +spelling-dict= -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= +# 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: -# 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 comma separated words that should not be checked. +spelling-ignore-words= -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant +[STRING] -[EXCEPTIONS] +# 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] -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception +# 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 + +# 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 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# 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 + +# 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_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a432452 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[project] +name = "ynm3k" +requires-python = ">3.8" \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 56f11df..b83fde4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1 @@ -tornado==4.5.2 +tornado==6.4 \ No newline at end of file diff --git a/ynm3k.py b/ynm3k.py index f06566e..a72cdf0 100644 --- a/ynm3k.py +++ b/ynm3k.py @@ -1,7 +1,6 @@ #!/usr/bin/env python # coding: utf-8 import sys -import time import uuid import datetime import mimetypes @@ -15,55 +14,55 @@ import tornado from tornado import gen +# pylint: disable=W0223 +# pylint: disable=C0115 +# pylint: disable=C0116 + def get_host_hash(): + """Generate hash from hostname""" hostname = socket.gethostname() m = hashlib.md5() - m.update(hostname) + m.update(hostname.encode("utf-8")) return m.hexdigest()[:7] class MyHandler(tornado.web.RequestHandler): - def head(self, *args, **kwargs): return self.get(*args, **kwargs) def set_default_headers(self): - self.set_header("Server", "YNM3K-%s" % SETTINGS['node_id']) + self.set_header("Server", f"YNM3K-{SETTINGS['node_id']}") self.set_header( "Set-Cookie", "csrftoken=8e0f2f299fede170969578ebceec0967; " - "expires=Thu, 09-Jan-2020 06:29:39 GMT; Max-Age=31449600; Path=/") + "expires=Thu, 09-Jan-2020 06:29:39 GMT; Max-Age=31449600; Path=/", + ) class MainHandler(MyHandler): - def get(self): - try: - headers = self.request.headers._dict - except: - headers = self.request.headers - + headers = self.request.headers links = [ - '/trace/', - '/static/abc.js', - '/static/abc/xyz.css', - '/static/abc/xyz/uvw.txt', - '/static/abc.html', - '/static/abc.jpg', - '/dynamic/abc.php', - '/dynamic/abc.asp', - '/code/200', - '/code/400', - '/code/404', - '/code/502', - '/size/11k.zip', - '/size/1k.bin', - '/slow/3', - '/slow/4-10', - '/redirect/301?url=http://www.notsobad.me', - '/redirect/302?url=http://www.notsobad.me', - '/redirect/js?url=http://www.notsobad.me', + "/trace/", + "/static/abc.js", + "/static/abc/xyz.css", + "/static/abc/xyz/uvw.txt", + "/static/abc.html", + "/static/abc.jpg", + "/dynamic/abc.php", + "/dynamic/abc.asp", + "/code/200", + "/code/400", + "/code/404", + "/code/502", + "/size/11k.zip", + "/size/1k.bin", + "/slow/3", + "/slow/4-10", + "/redirect/301?url=https://github.com/notsobad/ynm3k", + "/redirect/302?url=https://github.com/notsobad/ynm3k", + "/redirect/js?url=https://github.com/notsobad/ynm3k", ] - tpl = ''' + tpl = """

YNM3K Test site

Request header

{% for h in headers %}{{ h }}: {{ headers[h] }}
@@ -78,16 +77,16 @@ def get(self):
         
-        '''
+        """
         i = tornado.template.Template(tpl, whitespace="single")
-        out = i.generate(headers=headers, node_id=SETTINGS['node_id'], links=links)
+        out = i.generate(headers=headers, node_id=SETTINGS["node_id"], links=links)
         self.write(out)
 
+
 class TraceHandler(MyHandler):
     def get(self):
         self.set_header("Content-Type", "text/plain")
-        out = "{method} {url} {version}\r\n{headers}\r\n\r\n".format(method=self.request.method, 
-            url=self.request.uri, version=self.request.version, headers=str(self.request.headers))
+        out = f"{self.request.method} {self.request.uri} {self.request.version}\r\n{self.request.headers}\r\n\r\n" 
         self.write(out)
 
     def post(self):
@@ -95,105 +94,91 @@ def post(self):
 
 
 class FileHandler(MyHandler):
-
     def get(self, file_name):
         modified = datetime.datetime.now()
         self.set_header("Last-Modified", modified)
-        mime_type, encoding = mimetypes.guess_type(file_name)
+        mime_type, _ = mimetypes.guess_type(file_name)
         if mime_type:
             self.set_header("Content-Type", mime_type)
         try:
-            cache_time = int(self.request.headers.get('Cache', '95270'))
-        except:
+            cache_time = int(self.request.headers.get("Cache", "95270"))
+        except ValueError:
             cache_time = 95270
+
         if cache_time:
-            self.set_header("Expires", datetime.datetime.utcnow() +
-                            datetime.timedelta(seconds=cache_time))
-            self.set_header("Cache-Control", "max-age=" + str(cache_time))
-        self.write(file_name)
+            self.set_header(
+                "Expires",
+                datetime.datetime.utcnow() + datetime.timedelta(seconds=cache_time),
+            )
+            self.set_header("Cache-Control", f"max-age={cache_time}")
+        self.write(f"{file_name}\n")
 
 
 class DynamicHandler(MyHandler):
-
-    def get(self, file_name):
-        '''Generate random content for dynamic page'''
+    def get(self):
+        """Generate random content for dynamic page"""
         self.set_header("Content-Type", "text/html")
         d = {}
-        d['headers'] = dict(self.request.headers)
-        d['path'] = self.request.path
-        d['query'] = self.request.query
-        d['uri'] = self.request.uri
-        d['body'] = self.request.body
-        d['arguments'] = str(self.request.arguments)
+        d["headers"] = dict(self.request.headers)
+        d["path"] = self.request.path
+        d["query"] = self.request.query
+        d["uri"] = self.request.uri
+        d["body"] = self.request.body.decode("utf-8")
+        d["arguments"] = str(self.request.arguments)
 
         try:
-            i = int(self.request.headers.get('Cache', 0))
-            assert i
+            i = int(self.request.headers.get("Cache", 0))
+        except ValueError:
+            i = 0
+
+        if i > 0:
             self.set_header(
-                'Expires',
-                datetime.datetime.utcnow() + datetime.timedelta(seconds=i))
-            self.set_header('Cache-Control', 'max-age=%s' % i)
-        except:
-            pass
+                "Expires", datetime.datetime.utcnow() + datetime.timedelta(seconds=i)
+            )
+            self.set_header("Cache-Control", f"max-age={i}")
 
         j = json.dumps(d, indent=4, ensure_ascii=False)
-        self.write('hello :-)
%s

%s' % (j, uuid.uuid4())) + self.write(f"
{j}

{uuid.uuid4()}\n") post = get class CodeHandler(MyHandler): - def get(self, code): - '''pass''' + """pass""" code = int(code) self.send_error(code) - def write_error(self, code): - self.write( - '

Http %s


Generated at %s' % - (code, str( - datetime.datetime.now()))) - - def set_status(self, status_code, reason=None): - try: - super(CodeHandler, self).set_status(status_code, reason) - except: - tornado.web.RequestHandler._status_code = status_code - tornado.web.RequestHandler._reason = "unknown service error" + def write_error(self, status_code, **kargs): + self.finish( + f"

Http {status_code}


Generated at {datetime.datetime.now()}\n" + ) class SizeHandler(MyHandler): - def get(self, size): - '''Generate certain size file''' + """Generate certain size file""" size = size.lower() try: - if 'k' in size: - i = int(size.replace('k', '')) * 1024 - elif 'm' in size: - i = int(size.replace('m', '')) * 1024 * 1024 + if "k" in size: + i = int(size.replace("k", "")) * 1024 + elif "m" in size: + i = int(size.replace("m", "")) * 1024 * 1024 else: i = int(size) except ValueError: - return self.write('Wrong argument') + return self.write("Wrong argument\n") - self.set_header('Content-Description', 'File Transfer') - self.set_header('Content-Type', 'application/octet-stream') - #self.set_header('attachment','attachment; filename="a.zip"') - self.set_header('Content-Transfer-Encoding', 'binary') - return self.write('f' * i) + self.set_header("Content-Description", "File Transfer") + self.set_header("Content-Type", "application/octet-stream") + # self.set_header('attachment','attachment; filename="a.zip"') + self.set_header("Content-Transfer-Encoding", "binary") + return self.write("f" * i) class SlowHandler(MyHandler): - - @tornado.web.asynchronous - @gen.engine - def get(self, start, end=0): - ''' - Check https://gist.github.com/lbolla/3826189 - ''' - self.write("Start at: %s
" % datetime.datetime.now()) + async def get(self, start, end=0): + self.write(f"Start at: {datetime.datetime.now()}
\n") _start = int(start) _end = 0 @@ -205,49 +190,44 @@ def get(self, start, end=0): else: i = _start - yield gen.Task(tornado.ioloop.IOLoop.instance().add_timeout, time.time() + i) + await gen.sleep(i) - self.write("End at: %s
" % datetime.datetime.now()) - self.finish() + self.write(f"End at: {datetime.datetime.now()}
\n") class RedirectHandler(MyHandler): - def get(self, method): - url = self.get_argument('url') - if method in ('301', '302'): - self.redirect(url, permanent=(method == '301')) - elif method == 'js': - self.write('' % url) - elif method == 'meta': - self.write( - '' % - url) + url = self.get_argument("url") + if method in ("301", "302"): + self.redirect(url, status=int(method)) + elif method == "js": + self.write(f'\n' % url) + elif method == "meta": + self.write(f'\n') else: - self.write('wrong argument') + self.write("wrong argument\n") define("ip", help="ip to bind", default=None) define("port", help="port to listen", default=9527) define("debug", default=False, help="enable debug?") tornado.options.parse_command_line() -SETTINGS = { - 'debug': options.debug, - 'node_id': get_host_hash(), - 'gzip': True -} - -APP = tornado.web.Application([ - (r'/', MainHandler), - (r'/trace/?.*', TraceHandler), - (r'/static/(.*)', FileHandler), - (r'/dynamic/(.*)', DynamicHandler), - (r'/code/(\d+).*', CodeHandler), - (r'/size/([\d|k|m]+).*', SizeHandler), - (r'/slow/(\d+)-?(\d+)?.*', SlowHandler), - (r'/redirect/(.*)', RedirectHandler), - (r'/*', MainHandler), -], **SETTINGS) +SETTINGS = {"debug": options.debug, "node_id": get_host_hash(), "gzip": True} + +APP = tornado.web.Application( + [ + (r"/", MainHandler), + (r"/trace/?.*", TraceHandler), + (r"/static/(.*)", FileHandler), + (r"/dynamic/.*", DynamicHandler), + (r"/code/(\d+).*", CodeHandler), + (r"/size/([\d|k|m]+).*", SizeHandler), + (r"/slow/(\d+)-?(\d+)?.*", SlowHandler), + (r"/redirect/(.*)", RedirectHandler), + (r"/*", MainHandler), + ], + **SETTINGS, +) if __name__ == "__main__": if not options.port: