codegrapher 0.2.0__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.0 → 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/QMES0Na.png
-    :target: http://i.imgur.com/QMES0Na.png
+.. image:: docs/codegrapher.png
+    :target: docs/codegrapher.png
     :align: center
     :width: 100 %
     :alt: parser.py
@@ -56,6 +56,22 @@ To analyze a directory of files, along with all files it contains:
 
     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
 ~~~~~~~~~~~~~~~~~~
@@ -82,4 +98,7 @@ And then to add that code to a graph and render it (using graphviz):
     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`
+`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.0 → codegrapher-0.3.0}/cli/script.py

@@ -12,10 +12,11 @@ from codegrapher.parser import FileObject
 @click.option('-r', '--recursive', default=False, is_flag=True,
               help='Treat code argument as a directory and parse all files in directory, recursively')
 @click.option('--printed', default=False, is_flag=True, help='Pretty prints the call tree for each class in the file')
+@click.option('--ignore', default=False, is_flag=True, help='Use a .cg_ignore file to ignore functions in call tree')
 @click.option('--remove-builtins', default=False, is_flag=True, help='Removes builtin functions from call trees')
 @click.option('--output', help='Graphviz output file name')
 @click.option('--output-format', default='pdf', help='File type for graphviz output file')
-def cli(code, recursive, printed, remove_builtins, output, output_format):
+def cli(code, recursive, printed, ignore, remove_builtins, output, output_format):
     """
     Parses a file.
     codegrapher [file_name]
@@ -35,6 +36,9 @@ def cli(code, recursive, printed, remove_builtins, output, output_format):
         file_object.visit()
         if remove_builtins:
             file_object.remove_builtins()
+        if ignore:
+            file_object.add_ignore_file()
+            file_object.ignore_functions()
         if printed:
             click.echo('Classes in file {}:'.format(file_name))
             for class_object in file_object.classes:

codegrapher-0.3.0/codegrapher/__init__.py

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

{codegrapher-0.2.0 → codegrapher-0.3.0}/codegrapher/graph.py

@@ -13,12 +13,14 @@ class Node(object):
     Optimized to handle nodes that represent functions in a program.
 
     Attributes:
-        tuple (tuple): Contains the namespace, class, and function name for the current node.
+        tuple (tuple): Contains the namespace, class, and function name for the current node. If namespace is an empty
+            string, this contains just the class and function names. If a string is provided to the constructor this
+            is a tuple containing just the function name.
     """
     def __init__(self, input_node):
         if isinstance(input_node, tuple):
             if input_node[0] == '':
-                self.tuple = input_node[1:-1]
+                self.tuple = input_node[1:]
             else:
                 self.tuple = input_node
         else:
@@ -88,6 +90,8 @@ class FunctionGrapher(object):
         Arguments:
             class_names (list): List of class names to be recognized by the graph as `class_name.__init__` nodes.
             dictionary (dict): `ClassObject.call_tree` dict to be added to graph nodes and edges.
+            relative_namespace (string): Relative namespace for the current class, i.e. where the current class is
+                located relative to the root, in dotted path notation.
         """
         # todo: better handle project hierarchy by looking at imports
         # add nodes
@@ -116,20 +120,36 @@ class FunctionGrapher(object):
 
         Arguments:
             classes (list): list of :class:`codegrapher.parser.ClassObject` items.
+            relative_namespace (string): namespace of the current class.
         """
-        # todo: separate class methods from instance methods
         for cls in classes:
-            functions = set(fcn.name for fcn in cls.functions)
-            if '__init__' in functions:
+            # If a class is here, add it as a node
+            self.nodes.add(Node((relative_namespace, cls.name)))
+
+            if not all((fcn.is_classmethod for fcn in cls.functions)):
+                # for case where there is at least one non-classmethod, assume implied (or explicit) __init__
+
+                # make a node between the class name and __init__
                 self.nodes.add(Node((relative_namespace, cls.name, '__init__')))
-                for fcn in functions:
-                    if fcn == '__init__':
-                        continue  # skip the case where init would refer back to itself
-                    self.edges.add((Node((relative_namespace, cls.name, '__init__')),
-                                    Node((relative_namespace, cls.name, fcn))))
+                self.edges.add((Node((relative_namespace, cls.name)), Node((relative_namespace, cls.name, '__init__'))))
+                for fcn in cls.functions:
+                    # skip classmethods and case where init would refer back to itself
+                    if not fcn.is_classmethod and not fcn.name == '__init__':
+                        self.edges.add((Node((relative_namespace, cls.name, '__init__')),
+                                        Node((relative_namespace, cls.name, fcn.name))))
+                    elif fcn.is_classmethod:
+                        self.edges.add((Node((relative_namespace, cls.name)),
+                                        Node((relative_namespace, cls.name, fcn.name))))
+
+            else:
+                # for the case where there are only classmethods defined
+                for fcn in cls.functions:
+                    self.edges.add((Node((relative_namespace, cls.name)),
+                                    Node((relative_namespace, cls.name, fcn.name))))
 
     def render(self, name=None):
-        """ Renders the current graph.
+        """ Renders the current graph. `Graphviz <http://www.graphviz.org/>`_ must be installed for the graph to be
+            rendered.
 
         Arguments:
             name (string): filename to override `self.name`.