Installation¶

(requires git cli to be installed) .. code-block:: bash

$ python -m pip install ptcx

Usage¶

usage: python -m ptcx [-h] [--srcroot [SRCROOT]] [--patchroot [PATCHROOT]]
                      [--reset]
                      [path]

A format for modularized AST-based patching of arbitary code

positional arguments:
  path                  Relative path from patchroot to patch

options:
  -h, --help            show this help message and exit
  --srcroot [SRCROOT], --src [SRCROOT]
                        Source code directory to patch
  --patchroot [PATCHROOT], --patch [PATCHROOT]
                        directory where patches are placed.
  --reset               Resevert all uncommited changes within git repository
                        in src

Or over python:

ptcx.patch.path(_path='', srcroot='./src', patchroot='./patch')View on GitHub ¶

Apply patch to src

Parameters:

_path (PathLike )
srcroot (PathLike )
patchroot (PathLike )

ptcx.patch.reset(srcroot='./src')View on GitHub ¶

Resevert all uncommited changes within git repository in src

Parameters:: srcroot (PathLike )

Patch configuration¶

Example ptcx file: patch/main.py.ptcx 
Extra file to add: patch/extra.py 
Source file to patch: src/main.py 

from ptcx import BasePTC
import re

class PTC(BasePTC):
    def patch(self):
      self.sub(r"return res \+ 1", "return res")
      tree = self.tree
      print(self.file)

Language support¶

Language	python package
cpp	tree-sitter-python
python	tree-sitter-cpp

Reference¶

class ptcx.BasePTC(file, srcroot, patchroot)View on GitHub ¶

Parameters:

file (Path )
srcroot (Path )
patchroot (Path )

srcroot: Path ¶: source root directory to patch

patchroot: Path ¶: patch root directory, used for specifying patches

file: Path ¶: absolute path of the file to patch

property bytes: bytes View on GitHub ¶: File to patch as bytes based on ptcx.BasePTC.file(). Setting it to str will automatically convert it to bytes (utf-8 encoded)