Doc and cleanup.

.pylintrc

@@ -0,0 +1,582 @@
+[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. Specifying 0 will auto-detect the
+# number of processors available to use.
+jobs=1
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# 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,
+        file-ignored,
+        suppressed-message,
+        useless-suppression,
+        deprecated-pragma,
+        use-symbolic-message-instead,
+        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,
+        deprecated-operator-function,
+        deprecated-urllib-function,
+        xreadlines-attribute,
+        deprecated-sys-function,
+        exception-escape,
+        comprehension-escape,
+        too-many-return-statements,
+        invalid-name,
+        no-else-return,
+        too-many-statements,
+        too-many-branches,
+        no-else-raise,
+        no-member,
+        unused-argument,
+        no-value-for-parameter,
+        missing-docstring,
+        fixme
+
+
+# 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, e.g.
+# 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=sys.exit
+
+
+[STRING]
+
+# This flag controls whether the implicit-str-concat-in-sequence should
+# generate a warning on implicit string concatenation in sequences defined over
+# several lines.
+check-str-concat-over-line-jumps=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
+
+
+[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*(# )?<?https?://\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]
+
+# Format style used to check logging format string. `old` means using %
+# formatting, while `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
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+      XXX,
+      TODO
+
+
+[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
+
+
+[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 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. 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,builtins,io
+
+
+[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
+
+# 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 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
+
+
+[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.
+# These decorators are taken in consideration only for invalid-name.
+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=
+
+
+[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=cls
+
+
+[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 an 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
+# "BaseException, Exception".
+overgeneral-exceptions=BaseException,
+                       Exception

kapow.py

@@ -3,8 +3,7 @@
 A Kapow! interpreter written in Python.
 
 """
-from aiohttp import web
-from collections import defaultdict
+
 from dataclasses import dataclass
 from shlex import quote as shell_quote
 from string import Template
@@ -12,10 +11,13 @@ import asyncio
 import contextlib
 import io
 import os
-import re
 import tempfile
 
-from pyparsing import *
+from aiohttp import web
+from pyparsing import alphas, nums, White
+from pyparsing import LineStart, LineEnd, SkipTo
+from pyparsing import Literal, Combine, Word, Suppress
+from pyparsing import OneOrMore, Optional, delimitedList
 import aiofiles
 import click
 
@@ -24,35 +26,36 @@ import click
 ########################################################################
 
 # Method
-method = ( Literal('GET')
-         | Literal('POST')
-         | Literal('PUT')
-         | Literal('DELETE')
-         | Literal('PATCH') )
-multi_method = delimitedList(method, delim="|", combine=True)
-method_spec = Combine(Literal('*') | multi_method)
+METHOD = (Literal('GET')
+          | Literal('POST')
+          | Literal('PUT')
+          | Literal('DELETE')
+          | Literal('PATCH'))
+MULTI_METHOD = delimitedList(METHOD, delim="|", combine=True)
+METHOD_SPEC = Combine(Literal('*') | MULTI_METHOD)
 
 # Pattern
-regex = Word(alphas + nums + '\\+*,.[]-_')(name="regex")
-symbol = Word(alphas)(name="symbol")
-p_pattern = Combine('/{' + symbol + Optional(':' + regex) + '}')
-p_path = Word('/', alphas + nums + '$-_.+!*\'(),')
-urlpattern = Combine(OneOrMore(p_pattern | p_path))(name="urlpattern")
+REGEX = Word(alphas + nums + '\\+*,.[]-_')(name="regex")
+SYMBOL = Word(alphas)(name="symbol")
+P_PATTERN = Combine('/{' + SYMBOL + Optional(':' + REGEX) + '}')
+P_PATH = Word('/', alphas + nums + '$-_.+!*\'(),')
+URLPATTERN = Combine(OneOrMore(P_PATTERN | P_PATH))(name="urlpattern")
 
 # Body
-body = (Suppress('{') + SkipTo(Combine(LineStart() + '}' + LineEnd()))(name="body"))
+BODY = (Suppress('{')
+        + SkipTo(Combine(LineStart() + '}' + LineEnd()))(name="body"))
 
 # Endpoint head
-endpoint = (Optional(method_spec + Suppress(White()),
+ENDPOINT = (Optional(METHOD_SPEC + Suppress(White()),
                      default='*')(name="method")
-            + urlpattern
+            + URLPATTERN
             + Suppress(White()))
 
 # Endpoint bodies
-code_ep = (endpoint + body)(name="code_ep")
-path_ep = (endpoint + '=' + SkipTo(LineEnd())(name="path"))(name="path_ep")
+CODE_EP = (ENDPOINT + BODY)(name="code_ep")
+PATH_EP = (ENDPOINT + '=' + SkipTo(LineEnd())(name="path"))(name="path_ep")
 
-kapow_program = OneOrMore(code_ep | path_ep)
+KAPOW_PROGRAM = OneOrMore(CODE_EP | PATH_EP)
 
 
 ########################################################################
@@ -61,7 +64,10 @@ kapow_program = OneOrMore(code_ep | path_ep)
 
 @dataclass
 class ResourceManager:
+    """A resource exposed to the subshell."""
+    #: Representation of the resource that can be understood by the shell
     shell_repr: str
+    #: Coroutine capable of managing the resource internally
     coro: object
 
 
@@ -76,11 +82,11 @@ async def get_value(context, path):
     elif path == 'request/path':
         return context['request'].path.encode('utf-8')
     elif path.startswith('request/match'):
-        return  context['request'].match_info[nrd(2)].encode('utf-8')
+        return context['request'].match_info[nrd(2)].encode('utf-8')
     elif path.startswith('request/param'):
-        return  context['request'].rel_url.query[nrd(2)].encode('utf-8')
+        return context['request'].rel_url.query[nrd(2)].encode('utf-8')
     elif path.startswith('request/header'):
-        return  context['request'].headers[nrd(2)].encode('utf-8')
+        return context['request'].headers[nrd(2)].encode('utf-8')
     elif path.startswith('request/form'):
         return (await context['request'].post())[nrd(2)].encode('utf-8')
     elif path == 'request/body':
@@ -107,7 +113,8 @@ async def set_value(context, path, value):
     elif path == 'response/body':
         context['response_stream'].write(value)
     elif path.startswith('response/header/'):
-        context['response_headers'][nrd(2)] = value.rstrip(b'\n').decode('utf-8')
+        clean = value.rstrip(b'\n').decode('utf-8')
+        context['response_headers'][nrd(2)] = clean
     else:
         raise ValueError(f'Unknown path {path!r}')
 
@@ -248,10 +255,9 @@ class KapowTemplate(Template):
             code = self.substitute(**{k: v.shell_repr
                                       for k, v in resources.items()})
 
-            if False:
-                print('-'*80)
-                print(code)
-                print('-'*80)
+            # print('-'*80)
+            # print(code)
+            # print('-'*80)
 
             manager_tasks = [asyncio.create_task(v.coro)
                              for v in resources.values()]
@@ -259,7 +265,8 @@ class KapowTemplate(Template):
             shell_task = await asyncio.create_subprocess_shell(code)
 
             await shell_task.wait()  # Run the subshell process
-            done, pending = await asyncio.wait(manager_tasks, timeout=1)  # XXX: Managers commit changes 
+            # XXX: Managers commit changes
+            _, pending = await asyncio.wait(manager_tasks, timeout=1)
             if pending:
                 # print(f"Warning: Resources not consumed ({len(pending)})")
                 for task in pending:
@@ -267,7 +274,6 @@ class KapowTemplate(Template):
             await asyncio.sleep(0)
 
 
-
 def create_context(request):
     """Create a request context with default values."""
     context = dict()
@@ -296,7 +302,7 @@ def generate_endpoint(code):
     async def endpoint(request):
         context = create_context(request)
         await KapowTemplate(code).run(context)  # Will change context
-        return (await response_from_context(context))
+        return await response_from_context(context)
     return endpoint
 
 
@@ -325,6 +331,7 @@ def register_code_endpoint(app, methods, pattern, code):
     for method in methods:  # May be '*'
         app.add_routes([web.route(method, pattern, endpoint)])
 
+
 def register_path_endpoint(app, methods, pattern, path):
     """Register all needed endpoints for the defined file."""
     print(f"Registering [path] methods={methods!r} pattern={pattern!r}")
@@ -344,7 +351,7 @@ def main(ctx, program, expression):
 
     source = expression if program is None else program.read()
     app = web.Application()
-    for ep, _, _ in kapow_program.scanString(source):
+    for ep, _, _ in KAPOW_PROGRAM.scanString(source):
         if ep.body:
             register_code_endpoint(app,
                                    ep.method.asList()[0].split('|'),
@@ -357,5 +364,6 @@ def main(ctx, program, expression):
                                    ep.path)
     web.run_app(app)
 
+
 if __name__ == '__main__':
     main()

setup.py

@@ -0,0 +1,21 @@
+
+from setuptools import setup
+
+setup(
+    name='kapow',
+    version='0.0.1',
+    py_modules=['kapow'],
+    include_package_data=True,
+    install_requires=[
+        'aiofiles==0.4.0',
+        'aiohttp==3.5.4',
+        'pyparsing==2.3.1',
+        'Click==7.0'
+    ],
+    zip_safe=True,
+    entry_points={
+        'console_scripts': [
+            'kapow = kapow:main',
+        ]
+    }
+)