diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..e5751a6 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,534 @@ +[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=.pylintrc + +# 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, + 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=no + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[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 + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + + +[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 + + +[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 + + +[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 + + +[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, + _ + +# 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= + + +[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 + + +[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 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/host/__init__.py b/host/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/host/basic_host.py b/host/basic_host.py index b0c5a7d..5ea942a 100644 --- a/host/basic_host.py +++ b/host/basic_host.py @@ -1,9 +1,51 @@ -from host_interface import Host +from .host_interface import IHost -# Upon host creation, host takes in options, +# Upon host creation, host takes in options, # including the list of addresses on which to listen. -# Host then parses these options and delegates to its Network instance, +# Host then parses these options and delegates to its Network instance, # telling it to listen on the given listen addresses. -class BasicHost(Host): - pass \ No newline at end of file +class BasicHost(IHost): + + # default options constructor + def __init__(self, context, network): + self.context = context + self.network = network + + def get_id(self): + """ + :return: peer_id of host + """ + pass + + def get_network(self): + """ + :return: network instance of host + """ + pass + + def mux(self): + """ + :return: mux instance of host + """ + pass + + def set_stream_handler(self, protocol_id, stream_handler): + """ + set stream handler for host + :param protocol_id: protocol id used on stream + :param stream_handler: a stream handler function + :return: true if successful + """ + pass + + # protocol_id can be a list of protocol_ids + # stream will decide which protocol_id to run on + def new_stream(self, context, peer_id, protocol_id): + """ + :param context: a context instance + :param peer_id: peer_id that host is connecting + :param proto_id: protocol id that stream runs on + :return: true if successful + """ + pass diff --git a/host/host_interface.py b/host/host_interface.py index ac53c23..13ff83b 100644 --- a/host/host_interface.py +++ b/host/host_interface.py @@ -1,51 +1,51 @@ -from abc import ABC +from abc import ABC, abstractmethod -class Host(ABC): +class IHost(ABC): - # default options constructor - def __init__(self, context, network): - self.context = context - self.network = network + # default options constructor + def __init__(self, context, network): + self.context = context + self.network = network - @abstractmethod - def id(self): - """ - :return: peer_id of host - """ - pass + @abstractmethod + def get_id(self): + """ + :return: peer_id of host + """ + pass - @abstractmethod - def network(self): - """ - :return: network instance of host - """ - pass + @abstractmethod + def get_network(self): + """ + :return: network instance of host + """ + pass - @abstractmethod - def mux(self): - """ - :return: mux instance of host - """ - pass + @abstractmethod + def mux(self): + """ + :return: mux instance of host + """ + pass - @abstractmethod - def set_stream_handler(self, protocol_id, stream_handler): - """ - set stream handler for host - :param protocol_id: protocol id used on stream - :param stream_handler: a stream handler function - :return: true if successful - """ - pass + @abstractmethod + def set_stream_handler(self, protocol_id, stream_handler): + """ + set stream handler for host + :param protocol_id: protocol id used on stream + :param stream_handler: a stream handler function + :return: true if successful + """ + pass - # protocol_id can be a list of protocol_ids - # stream will decide which protocol_id to run on - @abstractmethod - def new_stream(self, context, peer_id, protocol_id): - """ - :param context: a context instance - :param peer_id: peer_id that host is connecting - :param proto_id: protocol id that stream runs on - :return: true if successful - """ - pass \ No newline at end of file + # protocol_id can be a list of protocol_ids + # stream will decide which protocol_id to run on + @abstractmethod + def new_stream(self, context, peer_id, protocol_id): + """ + :param context: a context instance + :param peer_id: peer_id that host is connecting + :param proto_id: protocol id that stream runs on + :return: true if successful + """ + pass diff --git a/network/__init__.py b/network/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/network/network_interface.py b/network/network_interface.py index fb6c7a4..46c2d57 100644 --- a/network/network_interface.py +++ b/network/network_interface.py @@ -1,25 +1,25 @@ -from abc import ABC +from abc import ABC, abstractmethod -class Network(ABC): +class INetwork(ABC): - def __init__(self, context, my_peer_id, peer_store): - self.context = context - self.my_peer_id = my_peer_id - self.peer_store = peer_store + def __init__(self, context, my_peer_id, peer_store): + self.context = context + self.my_peer_id = my_peer_id + self.peer_store = peer_store - @abstractmethod - def set_stream_handler(stream_handler): - """ - :param stream_handler: a stream handler instance - :return: true if successful - """ - pass + @abstractmethod + def set_stream_handler(self, stream_handler): + """ + :param stream_handler: a stream handler instance + :return: true if successful + """ + pass - @abstractmethod - def new_stream(context, peer_id): - """ - :param context: context instance - :param peer_id: peer_id of destination - :return: stream instance - """ - pass + @abstractmethod + def new_stream(self, context, peer_id): + """ + :param context: context instance + :param peer_id: peer_id of destination + :return: stream instance + """ + pass diff --git a/network/stream.py b/network/stream.py new file mode 100644 index 0000000..42fc1f3 --- /dev/null +++ b/network/stream.py @@ -0,0 +1,41 @@ +from .stream_interface import IStream + +class Stream(IStream): + + def __init__(self, context, peer_id): + self.context = context + self.peer_id = peer_id + + def protocol(self): + """ + :return: protocol id that stream runs on + """ + pass + + def set_protocol(self, protocol_id): + """ + :param protocol_id: protocol id that stream runs on + :return: true if successful + """ + pass + + def read(self): + """ + read from stream + :return: bytes of input + """ + pass + + def write(self, _bytes): + """ + write to stream + :return: number of bytes written + """ + pass + + def close(self): + """ + close stream + :return: true if successful + """ + pass diff --git a/network/stream_interface.py b/network/stream_interface.py index 3d92d8e..f49deb5 100644 --- a/network/stream_interface.py +++ b/network/stream_interface.py @@ -1,47 +1,46 @@ -from abc import ABC - -class Stream(ABC): - - def __init__(self, context, peer_id): - self.context = context - self.peer_id = peer_id - - @abstractmethod - def protocol(): - """ - :return: protocol id that stream runs on - """ - pass - - @abstractmethod - def set_protocol(protocol_id): - """ - :param protocol_id: protocol id that stream runs on - :return: true if successful - """ - pass - - @abstractmethod - def read(): - """ - read from stream - :return: bytes of input - """ - pass - - @abstractmethod - def write(bytes): - """ - write to stream - :return: number of bytes written - """ - pass - - @abstractmethod - def close(): - """ - close stream - :return: true if successful - """ - pass - +from abc import ABC, abstractmethod + +class IStream(ABC): + + def __init__(self, context, peer_id): + self.context = context + self.peer_id = peer_id + + @abstractmethod + def protocol(self): + """ + :return: protocol id that stream runs on + """ + pass + + @abstractmethod + def set_protocol(self, protocol_id): + """ + :param protocol_id: protocol id that stream runs on + :return: true if successful + """ + pass + + @abstractmethod + def read(self): + """ + read from stream + :return: bytes of input + """ + pass + + @abstractmethod + def write(self, _bytes): + """ + write to stream + :return: number of bytes written + """ + pass + + @abstractmethod + def close(self): + """ + close stream + :return: true if successful + """ + pass diff --git a/network/swarm.py b/network/swarm.py index feb91e3..b6db89a 100644 --- a/network/swarm.py +++ b/network/swarm.py @@ -1,4 +1,23 @@ -from network_interface import Network +from .network_interface import INetwork -class Swarm(Network): - pass \ No newline at end of file +class Swarm(INetwork): + + def __init__(self, context, my_peer_id, peer_store): + self.context = context + self.my_peer_id = my_peer_id + self.peer_store = peer_store + + def set_stream_handler(self, stream_handler): + """ + :param stream_handler: a stream handler instance + :return: true if successful + """ + pass + + def new_stream(self, context, peer_id): + """ + :param context: context instance + :param peer_id: peer_id of destination + :return: stream instance + """ + pass diff --git a/peer/__init__.py b/peer/__init__.py new file mode 100644 index 0000000..e69de29