codegrapher 0.2.1__tar.gz → 0.3.0__tar.gz

codegrapher-0.3.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

codegrapher-0.3.0/.github/workflows/main.yaml

@@ -0,0 +1,39 @@
+name: Codegrapher unit tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - name: Install project and dev dependencies
+      run: uv sync --locked --extra dev
+    - name: Test with pytest
+      run: uv run pytest tests --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml --cov --cov-report=xml --cov-report=html
+    - name: Upload test results
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: test-results-${{ matrix.python-version }}
+        path: junit/test-results-${{ matrix.python-version }}.xml
+    - name: Upload coverage report
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: coverage-report-${{ matrix.python-version }}
+        path: htmlcov/

codegrapher-0.3.0/.github/workflows/publish.yaml

@@ -0,0 +1,21 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Build distribution
+        run: uv build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

codegrapher-0.3.0/.gitignore

@@ -0,0 +1,13 @@
+.idea/
+codegrapher.egg-info
+*.pyc
+.coverage
+cover/
+dist/
+docs/_build/
+
+*.gv
+*.pdf
+*.png
+
+.python-version

codegrapher-0.3.0/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#   - requirements: docs/requirements.txt

codegrapher-0.3.0/LICENSE

@@ -0,0 +1,16 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Laura Rupprecht
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

codegrapher-0.3.0/Makefile

@@ -0,0 +1,16 @@
+.PHONY: install install-dev test build check
+
+install:
+	uv sync
+
+install-dev:
+	uv sync --extra dev
+
+test:
+	uv run pytest
+
+build:
+	uv build
+
+check:
+	twine check dist/*

codegrapher-0.3.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: codegrapher
+Version: 0.3.0
+Summary: Code that graphs code
+Project-URL: Homepage, https://github.com/LaurEars/codegrapher
+Project-URL: Repository, https://github.com/LaurEars/codegrapher
+Project-URL: Issues, https://github.com/LaurEars/codegrapher/issues
+Author: Laura Rupprecht
+License: The MIT License (MIT)
+        
+        Copyright (c) 2026 Laura Rupprecht
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+        documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+        rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+        persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+        Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+        WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+        OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-File: LICENSE
+Keywords: ast,call-graph,code,documentation,graph,graphviz
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.8
+Requires-Dist: click>=7.0
+Requires-Dist: graphviz>=0.4.2
+Provides-Extra: dev
+Requires-Dist: coverage>=5.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/x-rst
+
+codegrapher
+===========
+
+.. image:: https://github.com/LaurEars/codegrapher/actions/workflows/main.yaml/badge.svg
+    :target: https://github.com/LaurEars/codegrapher/actions/workflows/main.yaml
+
+
+Code that graphs code
+---------------------
+Uses the python `AST <https://docs.python.org/3/library/ast.html>`_ to parse Python source code and build a call graph.
+
+
+Output
+------
+An example of the current output of the parser parsing itself.
+
+.. image:: docs/codegrapher.png
+    :target: docs/codegrapher.png
+    :align: center
+    :width: 100 %
+    :alt: parser.py
+
+
+Installation
+------------
+
+.. code:: bash
+
+    pip install codegrapher
+
+
+To generate graphs, `graphviz <http://www.graphviz.org/Download.php>`_ must be installed.
+
+
+Usage
+-----
+
+At the command line
+~~~~~~~~~~~~~~~~~~~
+To parse a file and output results to the console:
+
+.. code:: bash
+
+    codegrapher path/to/file.py --printed
+
+
+To parse a file and output results to a file:
+
+.. code:: bash
+
+    codegrapher path/to/file.py --output output_file_name --output-type png
+
+To analyze a directory of files, along with all files it contains:
+
+.. code:: bash
+
+    codegrapher -r path/to/directory --output multiple_file_analysis
+
+And if you have a list of functions that aren't useful in your graph, add it to a `.cg_ignore` file:
+
+::
+
+    # cg_ignore file
+    # all lines beginning with '#' are ignored
+
+    # every function calls this, so it's not helpful in my graph:
+    log_error
+
+    # I don't want to see this in my graph:
+    parse
+    lower
+
+Then add the `--ignore` flag to your command. Using the flag `--remove-builtins` provides the same functionality
+for ignoring items found in `__builtins__`.
+
+As a Python module
+~~~~~~~~~~~~~~~~~~
+
+To easily parse code in Python :
+
+.. code:: python
+
+    from codegrapher.parser import FileObject
+
+    file_object = FileObject('path/to/file.py')
+    file_object.visit()
+
+And then to add that code to a graph and render it (using graphviz):
+
+.. code:: python
+
+    from codegrapher.graph import FunctionGrapher
+
+    graph = FunctionGrapher()
+    graph.add_file_to_graph(file_object)
+    graph.name = 'name.gv'
+    graph.format = 'png'
+    graph.render()
+
+Which will produce your code as a png file, `name.gv.png`, along with a
+`dot file <http://en.wikipedia.org/wiki/DOT_%28graph_description_language%29>`_ `name.gv`
+
+More documentation for the Python module can be found at
+`Read the Docs <http://codegrapher.readthedocs.org/en/latest/>`_.

{codegrapher-0.2.1 → codegrapher-0.3.0}/README.rst

@@ -1,21 +1,21 @@
 codegrapher
 ===========
 
-.. image:: https://travis-ci.org/LaurEars/codegrapher.svg?branch=master
-    :target: https://travis-ci.org/LaurEars/codegrapher
+.. image:: https://github.com/LaurEars/codegrapher/actions/workflows/main.yaml/badge.svg
+    :target: https://github.com/LaurEars/codegrapher/actions/workflows/main.yaml
 
 
 Code that graphs code
 ---------------------
-Uses the python `AST <https://docs.python.org/2/library/ast.html>`_ to parse Python source code and build a call graph.
+Uses the python `AST <https://docs.python.org/3/library/ast.html>`_ to parse Python source code and build a call graph.
 
 
 Output
 ------
 An example of the current output of the parser parsing itself.
 
-.. image:: http://i.imgur.com/2VnLaL0.png
-    :target: http://i.imgur.com/2VnLaL0.png
+.. image:: docs/codegrapher.png
+    :target: docs/codegrapher.png
     :align: center
     :width: 100 %
     :alt: parser.py

codegrapher-0.3.0/codegrapher/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.3.0'

{codegrapher-0.2.1 → codegrapher-0.3.0}/codegrapher/parser.py

@@ -1,11 +1,11 @@
-import os
 import ast
 import copy
+import os
 from pprint import pformat
 
 
-class FileObject(object):
-    """ Class for keeping track of files.
+class FileObject:
+    """Class for keeping track of files.
 
     Attributes:
         modules (dict): dict of current modules with `alias: module_name`, `key:value pairs`.
@@ -29,7 +29,7 @@ class FileObject(object):
         self.ignore = set()
 
     def visit(self):
-        """ Visits all the nodes within the current file AST node.
+        """Visits all the nodes within the current file AST node.
 
         Updates `self.classes` for the current instance.
         """
@@ -41,13 +41,12 @@ class FileObject(object):
         self.namespace()
 
     def remove_builtins(self):
-        """ Removes builtins from each class in a `FileObject` instance.
-        """
+        """Removes builtins from each class in a `FileObject` instance."""
         for class_object in self.classes:
             class_object.remove_builtins()
 
     def add_ignore_file(self):
-        """ Use a file `.cg_ignore` to ignore a list of functions from the call graph
+        """Use a file `.cg_ignore` to ignore a list of functions from the call graph
         """
         if os.path.isfile('.cg_ignore'):
             with open('.cg_ignore', 'r') as ignore_file:
@@ -56,21 +55,21 @@ class FileObject(object):
                         self.ignore.add(line.strip())
 
     def ignore_functions(self):
-        """ Ignore all functions in the current class which are present in the instance's `ignore` attribute.
+        """Ignore all functions in the current class which are present in the instance's `ignore` attribute.
         """
         for class_object in self.classes:
             class_object.ignore_functions(self.ignore)
 
     def namespace(self):
-        """ Programmatically change the name of items in the call tree so they have relative path information
+        """Programmatically change the name of items in the call tree so they have relative path information
         """
 
         for class_object in self.classes:
             class_object.namespace(self.relative_namespace)
 
 
-class ClassObject(object):
-    """ Class for keeping track of classes in code.
+class ClassObject:
+    """Class for keeping track of classes in code.
 
     Attributes:
         modules (dict): dict of current modules with `alias: module_name`, `key:value pairs`.
@@ -90,39 +89,30 @@ class ClassObject(object):
         self.call_tree = {}
 
     def visit(self):
-        """ Visits all the nodes within the current class AST node.
+        """Visits all the nodes within the current class AST node.
 
         Updates `self.functions` and `self.call_tree` for the current instance.
         """
         function_visitor = FunctionVisitor(aliases=self.aliases, modules=self.modules)
         function_visitor.visit(self.node)
         self.functions = function_visitor.functions
-        self.call_tree = dict(((self.name, k), v) for k, v in function_visitor.calls.iteritems())
+        self.call_tree = dict(((self.name, k), v) for k, v in function_visitor.calls.items())
 
     def remove_builtins(self):
-        """ For many classes, we may not want to include builtin functions in the graph.
+        """For many classes, we may not want to include builtin functions in the graph.
         Remove builtins from the call tree and from called functions list.
         """
-        new_call_tree = {}
-        for caller, call_list in self.call_tree.iteritems():
-            new_call_list = []
-            for call in call_list:
-                if __builtins__.has_key(call[0]):
-                    continue
-                else:
-                    new_call_list.append(call)
-            new_call_tree[caller] = new_call_list
-
-        self.call_tree = new_call_tree
+        self.call_tree = {caller: [call for call in call_list if not self.is_builtin(call[0])]
+            for caller, call_list in self.call_tree.items()}
 
     def ignore_functions(self, ignore_set):
-        """ Ignores all functions matching those specified in a pre-defined ignore set.
+        """Ignores all functions matching those specified in a pre-defined ignore set.
 
          Args:
             ignore_set (set): Functions whose calls should be removed (ignored) in the class call tree.
         """
         new_call_tree = {}
-        for caller, call_list in self.call_tree.iteritems():
+        for caller, call_list in self.call_tree.items():
             new_call_list = []
             for call in call_list:
                 if call[-1] not in ignore_set:
@@ -132,7 +122,7 @@ class ClassObject(object):
         self.call_tree = new_call_tree
 
     def namespace(self, relative_namespace):
-        """ Take the relative namespace for the class and prepend it to each item defined in the current class.
+        """Take the relative namespace for the class and prepend it to each item defined in the current class.
 
         Args:
             relative_namespace (string): Namespace to be prepended to each item in the call tree.
@@ -143,13 +133,20 @@ class ClassObject(object):
         self.call_tree = new_call_tree
 
     def pprint(self):
-        """ Pretty print formatter for class object.
+        """Pretty print formatter for class object.
 
         Returns:
             string
         """
         return pformat(self.call_tree)
 
+    @staticmethod
+    def is_builtin(fn):
+        """Checks if a """
+        if isinstance(fn, str):
+            return fn in __builtins__
+        return False
+
     def __repr__(self):
         return "ClassObject {}".format(self.name)
 
@@ -158,8 +155,8 @@ class ClassObject(object):
         return "Class {}\nDefined functions: {}".format(self.name, functions)
 
 
-class FunctionObject(object):
-    """ Object that stores information within a single function definition
+class FunctionObject:
+    """Object that stores information within a single function definition
 
     attributes:
         modules: dict of current modules with `alias: module_name`, `key:value pairs`.
@@ -183,7 +180,7 @@ class FunctionObject(object):
 
     @classmethod
     def _extract_decorators(cls, node):
-        """ Pulls out strings for each item in a decorator list on a FunctionDef node
+        """Pulls out strings for each item in a decorator list on a FunctionDef node
 
         Args:
             node (:mod:`ast.AST`): Node from which `decorator_list` will be extracted
@@ -200,7 +197,7 @@ class FunctionObject(object):
         return decorator_list
 
     def visit(self):
-        """ Visits all the nodes within the current function object's AST node.
+        """Visits all the nodes within the current function object's AST node.
 
         Updates `self.calls`, `self.modules`, and `self.aliases` for the current instance.
         """
@@ -215,7 +212,7 @@ class FunctionObject(object):
 
 
 class CallInspector(ast.NodeVisitor):
-    """ Within a call, a Name or Attribute will provide the function name currently in use.
+    """Within a call, a Name or Attribute will provide the function name currently in use.
 
     Identifies `Name` nodes, which are called as ``name(args)``, and `Attribute` nodes, which are called as
     ``object.attr(args)``
@@ -240,7 +237,7 @@ class CallInspector(ast.NodeVisitor):
 
 
 class ImportVisitor(ast.NodeVisitor):
-    """ For import related calls, store the source modules and aliases used.
+    """For import related calls, store the source modules and aliases used.
     Designed to be inherited by other classes that need to know about imports in their current scope.
 
     Attributes:
@@ -267,9 +264,9 @@ class ImportVisitor(ast.NodeVisitor):
             self.aliases[asname] = item.name
             self.modules[asname] = module
 
-        
+
 class CallVisitor(ImportVisitor):
-    """ Finds all calls present in the current scope and inspect them.
+    """Finds all calls present in the current scope and inspect them.
 
     Attributes:
         call_names (set): set of :class:`CallInspector.identifier` items within current AST node.
@@ -327,7 +324,7 @@ class CallVisitor(ImportVisitor):
 
 
 class FunctionVisitor(ImportVisitor):
-    """ Function definitions are where the function is defined, and the call is where the ast for that function exists.
+    """Function definitions are where the function is defined, and the call is where the ast for that function exists.
 
     This only looks for items that are called within the scope of a function, and associates those items
     with the function.
@@ -355,7 +352,7 @@ class FunctionVisitor(ImportVisitor):
 
 
 class FileVisitor(ImportVisitor):
-    """ First visitor that should be called on the file level.
+    """First visitor that should be called on the file level.
 
     Attributes:
         classes (list): list of :class:`ClassObject` instances defined in the current file.
@@ -377,7 +374,7 @@ class FileVisitor(ImportVisitor):
         self.classes.append(new_class)
 
     def remove_builtins(self):
-        """ Removes builtins from each class in a `FileVisitor` instance.
+        """Removes builtins from each class in a `FileVisitor` instance.
         """
         for class_object in self.classes:
             class_object.remove_builtins()