wizlib 0.9.2__tar.gz → 0.9.4__tar.gz

{wizlib-0.9.2 → wizlib-0.9.4}/PKG-INFO

@@ -1,10 +1,17 @@
 Metadata-Version: 2.1
 Name: wizlib
-Version: 0.9.2
-Summary: A collection of Python modules that are useful across multiple projects
-Author-email: Francis Potter <wizlib@steampunkwizard.ca>
+Version: 0.9.4
+Summary: A collection of Python modules that might be useful across multiple projects
 License: MIT
-Requires-Python: >=3.8
+Author: Steampunk Wizard
+Author-email: wizlib@steampunkwizard.ca
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
+Requires-Dist: gnureadline (>=8.1.2,<9.0.0) ; sys_platform == "darwin"
+Requires-Dist: pyreadline3 (>=3.4.1,<4.0.0) ; sys_platform == "win32"
 Description-Content-Type: text/markdown
 
 # WizLib
@@ -130,3 +137,4 @@ Emacs keys are enabled by default; I'm able to use the arrow keys on my Mac so y
 Logo by [Freepik](https://www.freepik.com/?_gl=1*1y9rvc9*test_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*test_ga_523JXC6VL7*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..*fp_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*fp_ga_1ZY8468CQB*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..)
 
 
+

wizlib-0.9.4/pyproject.toml

@@ -0,0 +1,28 @@
+[tool.poetry]
+name = "wizlib"
+version = "0.9.4"
+description = "A collection of Python modules that might be useful across multiple projects"
+authors = ["Steampunk Wizard <wizlib@steampunkwizard.ca>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+PyYAML = "^6.0.1"
+pyreadline3 = { version="^3.4.1", markers="sys_platform=='win32'" }
+gnureadline = { version="^8.1.2", markers="sys_platform=='darwin'" }
+
+[tool.poetry.group.dev.dependencies]
+coverage = "^7.3.1"
+pycodestyle = "^2.11.0"
+autopep8 = "^2.0.4"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+format = "{base}"
+

{wizlib-0.9.2 → wizlib-0.9.4}/wizlib/config_machine.py

@@ -2,6 +2,7 @@ from argparse import Namespace
 from pathlib import Path
 import os
 from dataclasses import dataclass
+from unittest.mock import patch
 
 from yaml import load
 from yaml import Loader
@@ -67,3 +68,16 @@ class ConfigMachine:
         """Allows a Command class to also inherit from ConfigMachine. List
         ConfigMachine first."""
         parser.add_argument('--config', action='store')
+
+
+def nohome_test():  # pragma: nocover
+    """Fake out a ConfigMachine so that it thinks test/files is the home
+    directory. This way it's not tempted to pull real configuration."""
+    return patch('pathlib.Path.home', lambda: Path('test/files'))
+
+
+def patchconfig_test(**kwargs):  # pragma: nocover
+    """Hand testable config data to a test method. First pass: always return
+    None."""
+    methodpath = 'wizlib.config_machine.ConfigMachine.config_get'
+    return patch(methodpath, lambda s, t: True)

wizlib-0.9.2/.version

@@ -1 +0,0 @@
-0.9.2

wizlib-0.9.2/pyproject.toml

@@ -1,25 +0,0 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "wizlib"
-authors = [
-    {name = "Francis Potter", email = "wizlib@steampunkwizard.ca"}
-]
-description = "A collection of Python modules that are useful across multiple projects"
-readme = "README.md"
-requires-python = ">=3.8"
-license = {text = "MIT"}
-dependencies = [
-    "gnureadline; platform_system=='Darwin'",
-    "pyreadline3; platform_system=='Windows'",
-    "PyYAML>=6.0.1"
-]
-dynamic = ["version"]
-
-[tool.setuptools.package-dir]
-wizlib = "wizlib"
-
-[tool.setuptools.dynamic]
-version = {file = [".version"]}

wizlib-0.9.2/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

wizlib-0.9.2/test/test_class_family.py

@@ -1,9 +0,0 @@
-from test.data_class_family.atriarch import Atriarch
-from unittest import TestCase
-
-
-class TestClassFamily(TestCase):
-
-    def test_family_children(self):
-        cx = Atriarch.family_children()
-        self.assertEqual(len(cx), 1)

wizlib-0.9.2/test/test_command_handler.py

@@ -1,57 +0,0 @@
-from unittest import TestCase
-from unittest.mock import patch
-from io import StringIO
-import os
-
-from wizlib.command_handler import CommandHandler
-from .data_command import TestCommand
-
-
-class TestCommandSync(TestCase):
-
-    def test_from_handler(self):
-        r, s = CommandHandler(TestCommand).handle(['play'])
-        self.assertEqual(r, 'Play!')
-
-    def test_default(self):
-        r, s = CommandHandler(TestCommand).handle()
-        self.assertEqual(r, 'Play!')
-
-    @patch('sys.stdout', StringIO())
-    def test_wrong_command(self):
-        h = CommandHandler(TestCommand)
-        c = h.get_command(['eat'])
-        self.assertIsNone(c)
-
-    @patch('sys.stdout', StringIO())
-    def test_handle_wrong_command(self):
-        h = CommandHandler(TestCommand)
-        r, s = h.handle(['eat'])
-        self.assertIsNone(r)
-
-    def test_command_arg(self):
-        h = CommandHandler(TestCommand)
-        c = h.get_command(['play', '--dd', 't'])
-        self.assertEqual(c.dd, 't')
-
-    def test_atriarch_args(self):
-        h = CommandHandler(TestCommand)
-        c = h.get_command(['--xx', 'y', 'play'])
-        self.assertEqual(c.xx, 'y')
-
-    def test_error(self):
-        with patch('sys.stdout', o := StringIO()):
-            with patch('sys.argv', ['', 'error']):
-                CommandHandler.shell(TestCommand)
-        o.seek(0)
-        r = o.read()
-        self.assertIn('division by zero', r)
-        self.assertEqual(len(r.splitlines()), 3)
-
-    @patch('sys.stdout', StringIO())
-    def test_error_debug(self):
-        os.environ['DEBUG'] = '1'
-        with self.assertRaises(ZeroDivisionError):
-            with patch('sys.argv', ['', 'error']):
-                CommandHandler.shell(TestCommand)
-        del os.environ['DEBUG']

wizlib-0.9.2/test/test_config_machine.py

@@ -1,90 +0,0 @@
-from unittest import TestCase
-from argparse import ArgumentParser
-import os
-from unittest.mock import patch
-from pathlib import Path
-
-from wizlib.config_machine import ConfigMachine
-from .data_config_machine.sample import SampleMachine
-from .data_config_machine.sample import SampleCommandMachine
-from .data_config_machine.sample import SampleOtherMachine
-
-
-class TestConfig(TestCase):
-
-    def test_direct_arg(self):
-        test_machine = SampleMachine(foo='bar')
-        f = test_machine.config_get('foo')
-        self.assertEqual(f, 'bar')
-
-    def test_config_file_arg(self):
-        sample = SampleMachine(
-            config='test/data_config_machine/test-config.yml')
-        f = sample.config_get('foo')
-        self.assertEqual(f, 'erg')
-
-    def test_nested_entry(self):
-        sample = SampleMachine(
-            config='test/data_config_machine/test-config.yml')
-        f = sample.config_get('bar-zing')
-        self.assertEqual(f, 'ech')
-
-    def test_nested_entry_fail(self):
-        sample = SampleMachine(
-            config='test/data_config_machine/test-config.yml')
-        f = sample.config_get('bar-za')
-        self.assertIsNone(f)
-
-    def test_specific_env_var(self):
-        os.environ['DEF_G'] = 'ju'
-        test_machine = SampleMachine()
-        f = test_machine.config_get('def-g')
-        del os.environ['DEF_G']
-        self.assertEqual(f, 'ju')
-
-    def test_conf_file_env_var(self):
-        os.environ['MYAPP_CONFIG'] = 'test/data_config_machine/test-config.yml'
-        test_machine = SampleMachine()
-        f = test_machine.config_get('bar-zing')
-        del os.environ['MYAPP_CONFIG']
-        self.assertEqual(f, 'ech')
-
-    def test_conf_file_env_var_specific_name(self):
-        os.environ['MYAPP2_CONFIG'] = \
-            'test/data_config_machine/test-config.yml'
-        test_machine = SampleMachine(appname='myapp2')
-        f = test_machine.config_get('bar-zing')
-        del os.environ['MYAPP2_CONFIG']
-        self.assertEqual(f, 'ech')
-
-    def test_local_config_file(self):
-        with patch('pathlib.Path.cwd',
-                   lambda: Path('test/data_config_machine')):
-            test_machine = SampleMachine()
-            f = test_machine.config_get('bar-zing')
-        self.assertEqual(f, 'ech')
-
-    def test_home_config_file(self):
-        with patch('pathlib.Path.home',
-                   lambda: Path('test/data_config_machine')):
-            test_machine = SampleMachine()
-            f = test_machine.config_get('bar-zing')
-        self.assertEqual(f, 'ech')
-
-    def test_works_with_command(self):
-        sample = SampleCommandMachine(
-            config='test/data_config_machine/test-config.yml')
-        f = sample.config_get('foo')
-        self.assertEqual(f, 'erg')
-
-    def works_another_way(self):
-        with patch('pathlib.Path.cwd',
-                   lambda: Path('test/data_config_machine')):
-            test_machine = SampleOtherMachine()
-            f = test_machine.config_get('bar-zing')
-        self.assertEqual(f, 'waa')
-
-    def test_nested_as_attribute(self):
-        c = SampleMachine()
-        c.a_b = 'c'
-        self.assertEqual(c.config_get('a-b'), 'c')

wizlib-0.9.2/test/test_super_wrapper.py

@@ -1,51 +0,0 @@
-from unittest import TestCase
-from unittest.mock import patch
-from io import StringIO
-
-from wizlib.super_wrapper import SuperWrapper
-
-correct = """
-Parent execute before
-IB execute before
-    Hello Jane
-    IB execute after
-    Parent execute after
-"""
-
-
-class TestSuperWrapper(TestCase):
-
-    def test_super_wrapper(self):
-
-        class Parent(SuperWrapper):
-            def execute(self, method, *args, **kwargs):
-                print(f"Parent execute before")
-                method(self, *args, **kwargs)
-                print(f"Parent execute after")
-
-        class InBetween(Parent):
-            @Parent.wrap
-            def execute(self, method, *args, **kwargs):
-                print(f"IB execute before")
-                method(self, *args, **kwargs)
-                print(f"IB execute after")
-
-        class NewChild(InBetween):
-            @InBetween.wrap
-            def execute(self, name):
-                print(f"Hello {name}")
-
-        with patch('sys.stdout', o := StringIO()):
-            c = NewChild()
-            c.execute("Jane")
-        o.seek(0)
-        r = o.read()
-        correct = """
-            Parent execute before
-            IB execute before
-            Hello Jane
-            IB execute after
-            Parent execute after
-        """.lstrip().split('\n')
-        correct_clean = '\n'.join([i.lstrip() for i in correct])
-        self.assertEqual(r, correct_clean)

wizlib-0.9.2/wizlib.egg-info/PKG-INFO

@@ -1,132 +0,0 @@
-Metadata-Version: 2.1
-Name: wizlib
-Version: 0.9.2
-Summary: A collection of Python modules that are useful across multiple projects
-Author-email: Francis Potter <wizlib@steampunkwizard.ca>
-License: MIT
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-
-# WizLib
-
-A collection of Python modules that might be useful across multiple projects
-
-## ClassFamily
-
-A class family is a set of class definitions that use single inheritance
-(each subclass inherits from only one parent) and often multiple inheritance
-(subclasses can inherit from subclasses). So it's a hierarchy of classes,
-with one super-parent (termed the "atriarch") at the top.
-
-We offer a way for members of the family to declare themselves simply by
-living in the right package location. Then those classes can be instantiated
-using keys or names, without having to be specifically called. The members
-act independently of each other.
-
-What we get, after importing everything and loading it all, is essentially a
-little database of classes, where class-level properties become keys for
-looking up member classes. So, for example, we can have a family of commands,
-and use a command string to look up the right command.
-
-Ultimately, the atriarch of the family -- the class at the top of the
-hierarchy -- holds the database, actually a list, in the property called
-"family". So that class can be queried to find appropriate family member
-classes or instances thereof.
-
-This utility provides functions for importing family members, loading the
-"families" property of the super-parent, and querying the family.
-
-In the process of loading and querying the class family, we need to *avoid*
-inheritance of attributes. There might be abstract intermediary classes that
-don't want to play. So we use `__dict__` to ensure we're only seeing the
-atttributes that are defined on that specific class.
-
-## SuperWrapper
-
-Provide a decorator to wrap a method so that it's called within the inherited
-version of that method.
-
-Example of use:
-
-```python
-class Parent(SuperWrapper):
-    def execute(self, method, *args, **kwargs):
-        print(f"Parent execute before")
-        method(self, *args, **kwargs)
-        print(f"Parent execute after")
-
-class InBetween(Parent):
-    @Parent.wrap
-    def execute(self, method, *args, **kwargs):
-        print(f"IB execute before")
-        method(self, *args, **kwargs)
-        print(f"IB execute after")
-
-class NewChild(InBetween):
-    @InBetween.wrap
-    def execute(self, name):
-        print(f"Hello {name}")
-
-c = NewChild()
-c.execute("Jane")
-```
-
-Note that for a method to be "wrappable" it must take the form shown above, and explicitly call the method that's handed into it. So strictly, this is different from regular inheritance, where the parent class method has the same signature as the child class method.
-
-
-## CommandHandler
-
-## ConfigMachine
-
-Enables easy configuration across multiple levels. Tries each of the following approaches in order until one finds the required config option
-
-- First look for specific options (ie. `--gitlab-host`) on the command line, typically hyphenated
-- Then look for a specific env variable for that config setting in all caps, e.g. `GITLAB_HOST`
-- If those both fail, then look for a YAML configuration file:
-    - First identified with a `--config` / `-c` option on the command line
-    - Then with a path in the `APPNAME_CONFIG` environment variable - note all caps
-    - Then look in the local working directory for `.appname.yml`
-    - Then look for `~/.appname.yml` in the user's home directory
-
-Config files are in YAML, and look something like this:
-
-```yaml
-gitlab:
-  host: gitlab.com
-local:
-  root: $HOME/git
-```
-
-Note that nested labels in the config map to hyphenated command line options.
-
-To use the library:
-
-```python
-config = ConfigMachine('appname', args)
-host = config.get('gitlab-host')
-```
-
-This assumes that `args` represents the result of `ArgumentParser` - in otherwords, a `Namespace` object.
-
-## RLInput
-
-Python supports the GNU readline approach, which enables tab completion, key mappings, and history with the `input()` function. But the documentation is cryptic, and the implementation differs between Linux and MacOS. RLInput makes it easy.
-
-```python
-from wizlib.rlinput import rlinput
-```
-
-It's just a function, with up to three parameters:
-
-- `intro:str=""` - The intro or prompt, same as in the `input()` function.
-- `default:str=""` - If provided, the text will be inserted into the buffer at the start, with the cursor at the end of the buffer. So that becomes the default, that must be overridden by the user if they want different input.
-- `options:list=[]` - A list of options for tab completion. This assumes the options are choices for the entire entry; it's not context-dependent within the buffer.
-
-Emacs keys are enabled by default; I'm able to use the arrow keys on my Mac so you should too. I made one change to the keyboard mappings, which is the Ctrl-A, instead of just moving the cursor to the beginning of the line, wipes the entire buffer. So to wipe out the default value and type or tab something new, just hit Ctrl-A.
-
-
----
-
-Logo by [Freepik](https://www.freepik.com/?_gl=1*1y9rvc9*test_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*test_ga_523JXC6VL7*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..*fp_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*fp_ga_1ZY8468CQB*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..)
-
-

wizlib-0.9.2/wizlib.egg-info/SOURCES.txt

@@ -1,18 +0,0 @@
-.version
-README.md
-pyproject.toml
-test/test_class_family.py
-test/test_command_handler.py
-test/test_config_machine.py
-test/test_super_wrapper.py
-wizlib/__init__.py
-wizlib/class_family.py
-wizlib/command_handler.py
-wizlib/config_machine.py
-wizlib/rlinput.py
-wizlib/super_wrapper.py
-wizlib.egg-info/PKG-INFO
-wizlib.egg-info/SOURCES.txt
-wizlib.egg-info/dependency_links.txt
-wizlib.egg-info/requires.txt
-wizlib.egg-info/top_level.txt

wizlib-0.9.2/wizlib.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

wizlib-0.9.2/wizlib.egg-info/requires.txt

@@ -1,7 +0,0 @@
-PyYAML>=6.0.1
-
-[:platform_system == "Darwin"]
-gnureadline
-
-[:platform_system == "Windows"]
-pyreadline3

wizlib-0.9.2/wizlib.egg-info/top_level.txt

@@ -1 +0,0 @@
-wizlib