diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..300d289 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +MANIFEST +dist/ +*.pyc +build/ +dxlmaxmindclient.egg-info/ +sample/dxlmaxmindservice.config diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..3203ff5 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,557 @@ +[MASTER] + +# 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-whitelist= + +# Add files or directories to the blacklist. 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= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +jobs=1 + +# 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 + +# Specify a configuration file. +#rcfile= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# 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=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, + unused-wildcard-import, + wildcard-import, + broad-except, + too-few-public-methods, + missing-docstring + + +# 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=text + +# 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 + + +[BASIC] + +# Naming style matching correct argument names +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# 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 +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Naming style matching correct class attribute names +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style +#class-attribute-rgx= + +# Naming style matching correct class names +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming-style +#class-rgx= + +# Naming style matching correct constant names +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-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 +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma +good-names=i, + j, + k, + ex, + Run, + _, + f, + fh, + logger, + running, + run_condition, + config_dir, + logging_config_path, + log_formatter, + console_handler + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming style matching correct inline iteration names +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style +#inlinevar-rgx= + +# Naming style matching correct method names +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style +#method-rgx= + +# Naming style matching correct module names +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style +#module-rgx= + +# 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=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style +#variable-rgx= + + +[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 + +# 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 + +# 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 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# 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= + +# 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 + + +[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 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 + +# 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 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 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 + +# 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 + + +[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] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# 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 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# 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 + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub, + TERMIOS, + Bastion, + rexec + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in 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 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.pylintrc.samples b/.pylintrc.samples new file mode 100644 index 0000000..89859c3 --- /dev/null +++ b/.pylintrc.samples @@ -0,0 +1,553 @@ +[MASTER] + +# 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-whitelist= + +# Add files or directories to the blacklist. 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= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +jobs=1 + +# 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 + +# Specify a configuration file. +#rcfile= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# 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=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, + invalid-name, + wrong-import-position, + missing-docstring, + wildcard-import, + unused-wildcard-import, + broad-except, + too-few-public-methods, + redefined-outer-name, + undefined-variable, + logging-not-lazy, + import-error, + similarities + + +# 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=text + +# 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 + + +[BASIC] + +# Naming style matching correct argument names +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# 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 +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Naming style matching correct class attribute names +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style +#class-attribute-rgx= + +# Naming style matching correct class names +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming-style +#class-rgx= + +# Naming style matching correct constant names +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-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 +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma +good-names=i, + j, + k, + ex, + Run, + _, + logger + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming style matching correct inline iteration names +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style +#inlinevar-rgx= + +# Naming style matching correct method names +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style +#method-rgx= + +# Naming style matching correct module names +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style +#module-rgx= + +# 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=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style +#variable-rgx= + + +[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 + +# 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 + +# 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 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# 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= + +# 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 + + +[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 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 + +# 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 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 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 + +# 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 + + +[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] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# 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 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# 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 + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in 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 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.travis.yml b/.travis.yml index 81cecbe..54ad7a7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,6 +7,9 @@ services: python: - "2.7" + - "3.4" + - "3.5" + - "3.6" before_install: - docker pull opendxl/opendxl-broker @@ -15,15 +18,15 @@ before_install: # command to install dependencies install: - - pip install dxlclient dxlbootstrap - - pip install . + - pip install .[test] + # Install through setup.py should be redundant because of the preceding pip + # install. Just doing this to try to catch any high-level errors. + - python setup.py install before_script: - - python -m dxlclient provisionconfig dxlclient/test 127.0.0.1 client -u admin -p password - - cp dxlclient/test/dxlclient.config dxlclient/test/client_config.cfg - - sed -i -e "s/external/unique_broker_id_1/g" -e "/local/d" dxlclient/test/client_config.cfg - - cat dxlclient/test/client_config.cfg + - python -m dxlclient provisionconfig sample 127.0.0.1 client -u admin -p password + - cat sample/dxlclient.config # command to run tests script: - - python setup.py install + - python setup.py ci diff --git a/README b/README index 5a44307..e206386 100644 --- a/README +++ b/README @@ -28,7 +28,7 @@ For bugs, questions and discussions please use the `GitHub Issues MaxMind Geolocation DXL Python Client Library This distribution contains following directories:

@@ -28,7 +28,7 @@

MaxMind Geolocation DXL Python Client Library

- © Copyright 2017, McAfee LLC + © Copyright 2018, McAfee LLC
diff --git a/doc/sdk/basichostlookupexample.rst b/doc/sdk/basichostlookupexample.rst index 65d629a..b856e63 100644 --- a/doc/sdk/basichostlookupexample.rst +++ b/doc/sdk/basichostlookupexample.rst @@ -133,8 +133,8 @@ The majority of the sample code is shown below: resp_dict = client.lookup_host("www.google.com") # Print out the response (convert dictionary to JSON for pretty printing) - print "Response:\n{0}".format( - MessageUtils.dict_to_json(resp_dict, pretty_print=True)) + print("Response:\n{0}".format( + MessageUtils.dict_to_json(resp_dict, pretty_print=True))) Once a connection is established to the DXL fabric, a :class:`dxlmaxmindclient.client.MaxMindGeolocationClient` instance is diff --git a/doc/sdk/installation.rst b/doc/sdk/installation.rst index 5a48bd9..56ad401 100644 --- a/doc/sdk/installation.rst +++ b/doc/sdk/installation.rst @@ -13,6 +13,9 @@ Prerequisites * The MaxMind DXL service is running and available on the DXL fabric ``_ +* Python 2.7.9 or higher in the Python 2.x series or Python 3.4.0 or higher + in the Python 3.x series installed within a Windows or Linux environment. + Installation ************ diff --git a/dxlmaxmindclient/__init__.py b/dxlmaxmindclient/__init__.py index 3f4f2f4..4366717 100644 --- a/dxlmaxmindclient/__init__.py +++ b/dxlmaxmindclient/__init__.py @@ -1,9 +1,8 @@ from __future__ import absolute_import +from ._version import __version__ from .client import MaxMindGeolocationClient -__version__ = "0.1.0" - def get_version(): """ diff --git a/dxlmaxmindclient/_config/__init__.py b/dxlmaxmindclient/_config/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/dxlmaxmindclient/_config/sample/__init__.py b/dxlmaxmindclient/_config/sample/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/sample/dxlclient.config.dist b/dxlmaxmindclient/_config/sample/dxlclient.config similarity index 97% rename from sample/dxlclient.config.dist rename to dxlmaxmindclient/_config/sample/dxlclient.config index 23a6fbb..5365d90 100644 --- a/sample/dxlclient.config.dist +++ b/dxlmaxmindclient/_config/sample/dxlclient.config @@ -1,8 +1,8 @@ -[Certs] -BrokerCertChain= -CertFile= -PrivateKey= - -[Brokers] -unique_broker_id_1=broker_id_1;broker_port_1;broker_hostname_1;broker_ip_1 -unique_broker_id_2=broker_id_2;broker_port_2;broker_hostname_2;broker_ip_2 +[Certs] +BrokerCertChain= +CertFile= +PrivateKey= + +[Brokers] +unique_broker_id_1=broker_id_1;broker_port_1;broker_hostname_1;broker_ip_1 +unique_broker_id_2=broker_id_2;broker_port_2;broker_hostname_2;broker_ip_2 diff --git a/dxlmaxmindclient/_version.py b/dxlmaxmindclient/_version.py new file mode 100644 index 0000000..d3ec452 --- /dev/null +++ b/dxlmaxmindclient/_version.py @@ -0,0 +1 @@ +__version__ = "0.2.0" diff --git a/dxlmaxmindclient/client.py b/dxlmaxmindclient/client.py index 52ca465..1051ec6 100644 --- a/dxlmaxmindclient/client.py +++ b/dxlmaxmindclient/client.py @@ -1,42 +1,35 @@ -from dxlclient.message import Request -from dxlbootstrap.util import MessageUtils -from dxlbootstrap.client import Client - - -class MaxMindGeolocationClient(Client): - """ - The "MaxMind Geolocation Client" client wrapper class. - """ - - HOST_LOOKUP_TOPIC = "/opendxl-maxmind/service/geolocation/host_lookup" - - #: The host request parameter - _PARAM_HOST = "host" - - def __init__(self, dxl_client): - """ - Constructor parameters: - - :param dxl_client: The DXL client to use for communication with the fabric - """ - super(MaxMindGeolocationClient, self).__init__(dxl_client) - - def lookup_host(self, host): - """ - Looks up Geolocation information for the specified host/IP - - :param host: The host/IP to lookup - :return: A dictionary (``dict``) containing the details of the Geolocation lookup - """ - # Create the DXL request message - request = Request(self.HOST_LOOKUP_TOPIC) - - # Set the payload on the request message (Python dictionary to JSON payload) - MessageUtils.dict_to_json_payload(request, {self._PARAM_HOST: host}) - - # Perform a synchronous DXL request - response = self._dxl_sync_request(request) - - # Convert the JSON payload in the DXL response message to a Python dictionary - # and return it. - return MessageUtils.json_payload_to_dict(response) +from __future__ import absolute_import +from dxlclient.message import Request +from dxlbootstrap.util import MessageUtils +from dxlbootstrap.client import Client + + +class MaxMindGeolocationClient(Client): + """ + The "MaxMind Geolocation Client" client wrapper class. + """ + + HOST_LOOKUP_TOPIC = "/opendxl-maxmind/service/geolocation/host_lookup" + + #: The host request parameter + _PARAM_HOST = "host" + + def lookup_host(self, host): + """ + Looks up Geolocation information for the specified host/IP + + :param host: The host/IP to lookup + :return: A dictionary (``dict``) containing the details of the Geolocation lookup + """ + # Create the DXL request message + request = Request(self.HOST_LOOKUP_TOPIC) + + # Set the payload on the request message (Python dictionary to JSON payload) + MessageUtils.dict_to_json_payload(request, {self._PARAM_HOST: host}) + + # Perform a synchronous DXL request + response = self._dxl_sync_request(request) + + # Convert the JSON payload in the DXL response message to a Python dictionary + # and return it. + return MessageUtils.json_payload_to_dict(response) diff --git a/sample/basic/basic_host_lookup_example.py b/sample/basic/basic_host_lookup_example.py index cd76965..35a7c87 100644 --- a/sample/basic/basic_host_lookup_example.py +++ b/sample/basic/basic_host_lookup_example.py @@ -1,42 +1,44 @@ -# This sample invokes and displays the results of a MaxMind "host lookup" via DXL. - -import os -import sys - -from dxlbootstrap.util import MessageUtils -from dxlclient.client_config import DxlClientConfig -from dxlclient.client import DxlClient - -root_dir = os.path.dirname(os.path.abspath(__file__)) -sys.path.append(root_dir + "/../..") -sys.path.append(root_dir + "/..") - -from dxlmaxmindclient.client import MaxMindGeolocationClient - -# Import common logging and configuration -from common import * - -# Configure local logger -logging.getLogger().setLevel(logging.ERROR) -logger = logging.getLogger(__name__) - -# Create DXL configuration from file -config = DxlClientConfig.create_dxl_config_from_file(CONFIG_FILE) - -# Create the client -with DxlClient(config) as dxl_client: - - # Connect to the fabric - dxl_client.connect() - - logger.info("Connected to DXL fabric.") - - # Create client wrapper - client = MaxMindGeolocationClient(dxl_client) - - # Lookup a host - resp_dict = client.lookup_host("www.google.com") - - # Print out the response (convert dictionary to JSON for pretty printing) - print "Response:\n{0}".format( - MessageUtils.dict_to_json(resp_dict, pretty_print=True)) +# This sample invokes and displays the results of a MaxMind "host lookup" via DXL. + +from __future__ import absolute_import +from __future__ import print_function +import os +import sys + +from dxlbootstrap.util import MessageUtils +from dxlclient.client_config import DxlClientConfig +from dxlclient.client import DxlClient + +root_dir = os.path.dirname(os.path.abspath(__file__)) +sys.path.append(root_dir + "/../..") +sys.path.append(root_dir + "/..") + +from dxlmaxmindclient.client import MaxMindGeolocationClient + +# Import common logging and configuration +from common import * + +# Configure local logger +logging.getLogger().setLevel(logging.ERROR) +logger = logging.getLogger(__name__) + +# Create DXL configuration from file +config = DxlClientConfig.create_dxl_config_from_file(CONFIG_FILE) + +# Create the client +with DxlClient(config) as dxl_client: + + # Connect to the fabric + dxl_client.connect() + + logger.info("Connected to DXL fabric.") + + # Create client wrapper + client = MaxMindGeolocationClient(dxl_client) + + # Lookup a host + resp_dict = client.lookup_host("www.google.com") + + # Print out the response (convert dictionary to JSON for pretty printing) + print("Response:\n{0}".format( + MessageUtils.dict_to_json(resp_dict, pretty_print=True))) diff --git a/sample/common.py b/sample/common.py index de45345..60d414f 100644 --- a/sample/common.py +++ b/sample/common.py @@ -1,23 +1,24 @@ -""" -Common definitions for the samples. -This includes the defining the path to the configuration file used to initialize the DXL client -in addition to setting up the logger appropriately. -""" - -import os -import logging - -# Config file name. -CONFIG_FILE_NAME = "dxlclient.config" -CONFIG_FILE = os.path.dirname(os.path.abspath(__file__)) + "/" + CONFIG_FILE_NAME - -# Enable logging, this will also direct built-in DXL log messages. -# See - https://docs.python.org/2/howto/logging-cookbook.html -log_formatter = logging.Formatter('%(asctime)s %(name)s - %(levelname)s - %(message)s') - -console_handler = logging.StreamHandler() -console_handler.setFormatter(log_formatter) - -logger = logging.getLogger() -logger.addHandler(console_handler) -logger.setLevel(logging.INFO) +""" +Common definitions for the samples. +This includes the defining the path to the configuration file used to initialize the DXL client +in addition to setting up the logger appropriately. +""" + +from __future__ import absolute_import +import os +import logging + +# Config file name. +CONFIG_FILE_NAME = "dxlclient.config" +CONFIG_FILE = os.path.dirname(os.path.abspath(__file__)) + "/" + CONFIG_FILE_NAME + +# Enable logging, this will also direct built-in DXL log messages. +# See - https://docs.python.org/2/howto/logging-cookbook.html +log_formatter = logging.Formatter('%(asctime)s %(name)s - %(levelname)s - %(message)s') + +console_handler = logging.StreamHandler() +console_handler.setFormatter(log_formatter) + +logger = logging.getLogger() +logger.addHandler(console_handler) +logger.setLevel(logging.INFO) diff --git a/sample/dxlclient.config b/sample/dxlclient.config new file mode 100644 index 0000000..5365d90 --- /dev/null +++ b/sample/dxlclient.config @@ -0,0 +1,8 @@ +[Certs] +BrokerCertChain= +CertFile= +PrivateKey= + +[Brokers] +unique_broker_id_1=broker_id_1;broker_port_1;broker_hostname_1;broker_ip_1 +unique_broker_id_2=broker_id_2;broker_port_2;broker_hostname_2;broker_ip_2 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..14df7c4 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,3 @@ +[nosetests] +verbosity=2 +exe=1 diff --git a/setup.py b/setup.py index fe7008f..91a7c67 100644 --- a/setup.py +++ b/setup.py @@ -1,52 +1,127 @@ -from setuptools import setup -import distutils.command.sdist - -import setuptools.command.sdist - -# Patch setuptools' sdist behaviour with distutils' sdist behaviour -setuptools.command.sdist.sdist.run = distutils.command.sdist.sdist.run - -VERSION = __import__('dxlmaxmindclient').get_version() - -dist = setup( - # Package name: - name="dxlmaxmindclient", - - # Version number: - version=VERSION, - - # Requirements - install_requires=[ - "dxlbootstrap", - "dxlclient" - ], - - # Package author details: - author="McAfee LLC", - - # License - license="Apache License 2.0", - - # Keywords - keywords=['opendxl', 'dxl', 'mcafee', 'client', 'maxmind', 'geolocation'], - - # Packages - packages=[ - "dxlmaxmindclient", - ], - - # Details - url="http://www.mcafee.com/", - - description="MaxMind Geolocation DXL client library", - - long_description=open('README').read(), - - classifiers=[ - "Development Status :: 4 - Beta", - "Topic :: Software Development :: Libraries :: Python Modules", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 2.7", - ], -) +# pylint: disable=no-member, no-name-in-module, import-error + +from __future__ import absolute_import +import glob +import os +import distutils.command.sdist +import distutils.log +import subprocess +from setuptools import Command, setup +import setuptools.command.sdist + +# Patch setuptools' sdist behaviour with distutils' sdist behaviour +setuptools.command.sdist.sdist.run = distutils.command.sdist.sdist.run + +VERSION_INFO = {} +CWD = os.path.abspath(os.path.dirname(__file__)) +with open(os.path.join(CWD, "dxlmaxmindclient", "_version.py")) as f: + exec(f.read(), VERSION_INFO) # pylint: disable=exec-used + + +class LintCommand(Command): + """ + Custom setuptools command for running lint + """ + description = 'run lint against project source files' + user_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + self.announce("Running pylint for library source files and tests", + level=distutils.log.INFO) + subprocess.check_call(["pylint", "dxlmaxmindclient", "tests"] + + glob.glob("*.py")) + self.announce("Running pylint for samples", level=distutils.log.INFO) + subprocess.check_call(["pylint"] + glob.glob("sample/*.py") + + glob.glob("sample/**/*.py") + + ["--rcfile", ".pylintrc.samples"]) + + +class CiCommand(Command): + """ + Custom setuptools command for running steps that are performed during + Continuous Integration testing. + """ + description = 'run CI steps (lint, test, etc.)' + user_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + self.run_command("lint") + self.run_command("test") + +TEST_REQUIREMENTS = ["mock", "nose", "pylint", "dxlmaxmindservice"] + +DEV_REQUIREMENTS = TEST_REQUIREMENTS + ["sphinx"] + +setup( + # Package name: + name="dxlmaxmindclient", + + # Version number: + version=VERSION_INFO["__version__"], + + # Requirements + install_requires=[ + "dxlbootstrap>=0.2.0", + "dxlclient>=4.1.0.184" + ], + + tests_require=TEST_REQUIREMENTS, + + extras_require={ + "dev": DEV_REQUIREMENTS, + "test": TEST_REQUIREMENTS + }, + + test_suite="nose.collector", + + # Package author details: + author="McAfee LLC", + + # License + license="Apache License 2.0", + + # Keywords + keywords=['opendxl', 'dxl', 'mcafee', 'client', 'maxmind', 'geolocation'], + + # Packages + packages=[ + "dxlmaxmindclient", + "dxlmaxmindclient._config", + "dxlmaxmindclient._config.sample"], + + package_data={ + "dxlmaxmindclient._config.sample" : ['*']}, + + # Details + url="http://www.mcafee.com/", + + description="MaxMind Geolocation DXL client library", + + long_description=open('README').read(), + + python_requires='>=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*', + + classifiers=[ + "Development Status :: 4 - Beta", + "Topic :: Software Development :: Libraries :: Python Modules", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 2.7", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6" + ], + + cmdclass={ + "ci": CiCommand, + "lint": LintCommand + } +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_basic_host_lookup_example.py b/tests/test_basic_host_lookup_example.py new file mode 100644 index 0000000..87f463e --- /dev/null +++ b/tests/test_basic_host_lookup_example.py @@ -0,0 +1,31 @@ +import sys +import unittest + +if sys.version_info[0] > 2: + import builtins # pylint: disable=import-error, unused-import +else: + import __builtin__ # pylint: disable=import-error + builtins = __builtin__ # pylint: disable=invalid-name + +# pylint: disable=wrong-import-position +from mock import patch +import dxlmaxmindservice + + +class StringMatches(str): + def __eq__(self, other): + return self in other + + +class BasicHostLookupExample(unittest.TestCase): + MAX_WAIT = 90 + def test_basic_host_lookup_example(self): # pylint: disable=no-self-use + sample_file = "sample/basic/basic_host_lookup_example.py" + sample_globals = {"__file__": sample_file} + with dxlmaxmindservice.MaxMindGeolocationService("sample") as app: + app.run() + with open(sample_file) as f, \ + patch.object(builtins, 'print') as mock_print: + exec(f.read(), sample_globals) # pylint: disable=exec-used + mock_print.assert_called_with(StringMatches("Response:")) + mock_print.assert_called_with(StringMatches("registered_country"))