crackerjack 0.1.0__tar.gz

crackerjack-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Les Leslie & Wedgwood Web Works
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

crackerjack-0.1.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: crackerjack
+Version: 0.1.0
+Summary: Crackerjack code formatting style.
+Keywords: black ruff mypy deptry refurb
+Home-page: https://github.com/lesleslie/crackerjack
+Author-Email: lesleslie <les@wedgwoodwebworks.com>
+Maintainer-Email: lesleslie <les@wedgwoodwebworks.com>
+License: BSD-3-Clause
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Project-URL: Homepage, https://github.com/lesleslie/crackerjack
+Project-URL: Documentation, https://github.com/lesleslie/crackerjack
+Project-URL: Repository, https://github.com/lesleslie/crackerjack
+Requires-Python: >=3.11
+Requires-Dist: black>=23.3.0
+Requires-Dist: ruff>=0.0.261
+Requires-Dist: mypy>=1.2.0
+Requires-Dist: deptry>=0.8.0
+Requires-Dist: refurb>=1.15.0
+Requires-Dist: creosote>=2.6.0
+Description-Content-Type: text/markdown
+
+# Crackerjack Python
+
+[![Python: 3.7](https://img.shields.io/badge/python-3.10%2B-blue)](https://docs.python.org/3/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![Code style: crackerjack](https://img.shields.io/badge/code%20style-crackerjack-000042)](https://github.com/lesleslie/crackerjack)
+
+Crackerjack is a python coding, formatting, and documentation style for statically
+typed python >=3.10
+
+### **Why Crackerjack?**
+
+Crackerjack exists to make modern python code more elegant and readable.
+Let's face it, the python documentation system has been a major contributor to the
+languages popularity, but over time python code in packages and repositories has
+become so cluttered up with docstrings, doctests, and comments that it actually
+becomes really hard to find the actual code in it - nonetheless read through it.
+Yes, modern IDE's offer up options to fold the docstrings, but this doesn't help
+when looking through code on GitHub, or in an console based editor like vi and
+doesn't account for either for all the different ways that developers comment
+up their code. There must be some sanity!
+
+Enter Crackerjack. Crackerjack works on the theory that with statically typed python
+code and explicit class, function, variable, and other object names the code should be
+straight forward to read and the documentation should pretty much be able to write
+itself (can you say ai). Crackerjack also has coding style
+guidelines that exist to keep the codebase clean, elegant, standardized, and
+easily readable - give it to me straight basically.
+
+### **What does this package do?**
+
+Crackjack first cleans up the codebase by removing all docstrings and comments that
+ do not conform to Crackerjack standards (see below). The code is then reformatted to
+  the [Black](https://github.com/ambv/black) code style, unused imports are removed
+   with [autoflake](https://github.com/myint/autoflake), and remaining imports sorted
+    by [reorder_python_imports](https://github.com/asottile/reorder_python_imports).
+    After that 
+   [MonkeyType](https://monkeytype.readthedocs.io/en/stable/) is run to add type
+    annotations to the code and optionally run through 
+     [Mypy](https://mypy.readthedocs.io/en/latest/) to check for errors.
+      
+      
+### **What are the rules?**
+
+(...more what you'd call "guidelines" than actual rules. -Captain Barbossa )
+
+- All docstrings, README's, and other documentation is to be done in Markdown (md)
+
+- Code needs to be [black](https://github.com/ambv/black)'ed
+
+- Imports are one single import per line
+  (see [reorder_python_imports](https://github.com/asottile/reorder_python_imports
+  )) - this not only helps aviod merge conflicts but makes it easier to manipulate if
+  using hot-keys
+
+- Use pathlib.Path not os.path
+
+- If a function or class is performing file operations it should be passed a Path
+  object - not a string
+
+- Work in progress
+ 
+

crackerjack-0.1.0/README.md

@@ -0,0 +1,62 @@
+# Crackerjack Python
+
+[![Python: 3.7](https://img.shields.io/badge/python-3.10%2B-blue)](https://docs.python.org/3/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![Code style: crackerjack](https://img.shields.io/badge/code%20style-crackerjack-000042)](https://github.com/lesleslie/crackerjack)
+
+Crackerjack is a python coding, formatting, and documentation style for statically
+typed python >=3.10
+
+### **Why Crackerjack?**
+
+Crackerjack exists to make modern python code more elegant and readable.
+Let's face it, the python documentation system has been a major contributor to the
+languages popularity, but over time python code in packages and repositories has
+become so cluttered up with docstrings, doctests, and comments that it actually
+becomes really hard to find the actual code in it - nonetheless read through it.
+Yes, modern IDE's offer up options to fold the docstrings, but this doesn't help
+when looking through code on GitHub, or in an console based editor like vi and
+doesn't account for either for all the different ways that developers comment
+up their code. There must be some sanity!
+
+Enter Crackerjack. Crackerjack works on the theory that with statically typed python
+code and explicit class, function, variable, and other object names the code should be
+straight forward to read and the documentation should pretty much be able to write
+itself (can you say ai). Crackerjack also has coding style
+guidelines that exist to keep the codebase clean, elegant, standardized, and
+easily readable - give it to me straight basically.
+
+### **What does this package do?**
+
+Crackjack first cleans up the codebase by removing all docstrings and comments that
+ do not conform to Crackerjack standards (see below). The code is then reformatted to
+  the [Black](https://github.com/ambv/black) code style, unused imports are removed
+   with [autoflake](https://github.com/myint/autoflake), and remaining imports sorted
+    by [reorder_python_imports](https://github.com/asottile/reorder_python_imports).
+    After that 
+   [MonkeyType](https://monkeytype.readthedocs.io/en/stable/) is run to add type
+    annotations to the code and optionally run through 
+     [Mypy](https://mypy.readthedocs.io/en/latest/) to check for errors.
+      
+      
+### **What are the rules?**
+
+(...more what you'd call "guidelines" than actual rules. -Captain Barbossa )
+
+- All docstrings, README's, and other documentation is to be done in Markdown (md)
+
+- Code needs to be [black](https://github.com/ambv/black)'ed
+
+- Imports are one single import per line
+  (see [reorder_python_imports](https://github.com/asottile/reorder_python_imports
+  )) - this not only helps aviod merge conflicts but makes it easier to manipulate if
+  using hot-keys
+
+- Use pathlib.Path not os.path
+
+- If a function or class is performing file operations it should be passed a Path
+  object - not a string
+
+- Work in progress
+ 
+

crackerjack-0.1.0/crackerjack/crackerjack.py

@@ -0,0 +1,183 @@
+from dataclasses import dataclass
+from importlib import import_module
+from importlib.util import module_from_spec
+from importlib.util import spec_from_file_location
+from inspect import cleandoc
+from inspect import currentframe
+from inspect import getdoc
+from inspect import getfile
+from inspect import getmembers
+from inspect import isclass
+from inspect import isfunction
+from os import getcwd
+from pathlib import Path
+from shutil import copy2
+from subprocess import call
+
+from black import InvalidInput
+from black import format_str
+from click import command
+from click import help_option
+from click import option
+
+tab_indent = 2
+line_spacing = 2
+pager_delay = 0.042
+
+pd = pager_delay
+ti = "\t" * tab_indent
+ls = "\n" * line_spacing
+
+our_path = getfile(currentframe())
+our_parent = Path(our_path).resolve().parent
+our_imports = get_all_imports(our_parent)
+
+docs = []
+comments = []
+
+
+def process_doc(doc):
+    for l in (l.strip() for l in doc.splitlines() if not l.strip() in docs):
+        docs.append(l)
+
+
+def process_obj(obj):
+    doc = getdoc(obj[1])
+    if doc:
+        print(f"Removing doc string from:  {obj[0]}")
+        process_doc(doc)
+
+
+def get_doc(obj):
+    process_obj(obj)
+    functions = getmembers(obj[1], isfunction)
+    for obj2 in functions:
+        process_obj(obj2)
+        objs = getmembers(obj2[1], isfunction)
+        for obj3 in objs:
+            process_obj(obj3)
+
+
+@dataclass
+class FormatResponse:
+    input: str = None
+    ouput: str = None
+    success: bool = False
+    error: str = None
+
+
+def process_text(text):
+    resp = FormatResponse()
+    try:
+        text = cleandoc(text)
+        resp.output = format_str(text, line_length=88)
+        resp.success = True
+    except InvalidInput as err:
+        resp.error = err
+        print(f"!!! InvalidInput  -  {err}")
+    # except TokenError as err:
+    #     resp.error = err
+    #     print(f"!!! TokenError  -  {err}")
+    finally:
+        resp.output = cleandoc(text)
+        return resp
+
+
+def install(package):
+    try:
+        import_module(package)
+    except ImportError:
+        print("Installing: ", package)
+        call(["pip", "install", package, "--disable-pip-version-check"])
+    finally:
+        globals()[package] = import_module(package)
+
+
+def uninstall(package):
+    if (package == "pip") or (package in our_imports):
+        return False
+    print("Uninstalling: ", package)
+    call(["pip", "uninstall", package, "-y"])
+    return True
+
+
+def crackerjack_it(
+    fp: Path,
+    exclude: bool = False,
+    interactive: bool = False,
+    dry_run: bool = False,
+    verbose: bool = False,
+):
+    print("\nCrackerJacking...\n")
+    module_imports = get_all_imports(getcwd())
+    for m in module_imports:
+        install(m)
+    text = fp.read_text()
+    print("\nPre-processing text.....\n\n")
+    text = process_text(text).ouput
+    spec = spec_from_file_location(str(fp.resolve()))
+    module = module_from_spec(spec)
+    spec.loader.exec_module(module)
+    functions = getmembers(module, isfunction)
+    classes = getmembers(module, isclass)
+    for obj in classes + functions:
+        get_doc(obj)
+    for line in docs:
+        text = text.replace(line, "")
+    if not exclude:
+        print("\nRemoving remaining docstrings, comments, and blank lines.....\n\n")
+        lines = list()
+        del_lines = False
+        for line in text.splitlines(True):
+            print(line)
+            if len(line) < 2:
+                print(1)
+                continue
+            elif '"""' in line:
+                print(2)
+                del_lines = not del_lines
+                continue
+            elif del_lines:
+                print(3)
+                continue
+            elif line.lstrip().startswith("#"):
+                print(4)
+                continue
+            lines.append(line)
+        text = "".join(lines)
+    print("\nPost-processing text.....\n\n")
+    resp = process_text(text)
+    if resp.success:
+        print(resp.output)
+        print("\n\n\t*** Success! ***\n\n")
+        if not dry_run:
+            copy2(fp.name, (fp / ".old").name)
+            fp.write_text(resp.output)
+    elif resp.error:
+        print(f"Error formatting: {resp.error}\n\n")
+    for m in module_imports:
+        uninstall(m)
+
+
+@command()
+@help_option("-h", is_flag=True, help="help")
+@option("-x", is_flag=True, help="exclude comments")
+@option("-i", is_flag=True, help="interactive")
+@option("-d", is_flag=True, help="dry run")
+@option("-v", is_flag=True, help="verbose")
+@option("-f", help="crackerjack format: -f [module]")
+def crackerjack(f, x, i, d, v):
+    options = dict()
+    if x:
+        options["exclude"] = x
+    if i:
+        print("-i not currently implemented.")
+        options["interactive"] = i
+    if d:
+        options["dry_run"] = d
+    if v:
+        print("-v not currently implemented.")
+        options["verbose"] = v
+    if f:
+        cwd = Path(Path.cwd())
+        crackerjack_it(cwd / f, **options)

crackerjack-0.1.0/pyproject.toml

@@ -0,0 +1,80 @@
+[tool.pdm.dev-dependencies]
+dev = [
+    "pytest>=7.3.0",
+]
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.isort]
+profile = "black"
+line-length = 88
+include-trailing-comma = true
+use-parentheses = true
+multi-line-output = 3
+
+[tool.black]
+target-version = [
+    "py311",
+]
+
+[tool.mypy]
+strict = true
+
+[tool.deptry]
+
+[tool.refurb]
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[project]
+name = "Crackerjack"
+version = "0.1.0"
+description = "Crackerjack code formatting style."
+authors = [
+    { name = "lesleslie", email = "les@wedgwoodwebworks.com" },
+]
+maintainers = [
+    { name = "lesleslie", email = "les@wedgwoodwebworks.com" },
+]
+requires-python = ">=3.11"
+readme = "README.md"
+keywords = [
+    "black",
+    "ruff",
+    "mypy",
+    "deptry",
+    "refurb",
+]
+classifiers = [
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+    "black>=23.3.0",
+    "ruff>=0.0.261",
+    "mypy>=1.2.0",
+    "deptry>=0.8.0",
+    "refurb>=1.15.0",
+    "creosote>=2.6.0",
+]
+
+[project.license]
+text = "BSD-3-Clause"
+
+[project.optional-dependencies]
+
+[project.urls]
+homepage = "https://github.com/lesleslie/crackerjack"
+documentation = "https://github.com/lesleslie/crackerjack"
+repository = "https://github.com/lesleslie/crackerjack"
+
+[project.scripts]
+
+[project.entry-points]