physdes-py 0.5__tar.gz → 0.7__tar.gz

{physdes_py-0.5 → physdes_py-0.7}/.benchmarks/test_area.py

@@ -16,14 +16,14 @@ def rectilinear_polygon_points():
     return [Point(x, y) for x, y in RECTILINEAR_POLYGON_COORDS]
 
 
-def test_polygon_signed_area(benchmark, rectilinear_polygon_points):
+def test_polygon_signed_area(benchmark, rectilinear_polygon_points) -> None:
     rp = RPolygon(rectilinear_polygon_points)
     p: Polygon = rp.to_polygon()
     result = benchmark(lambda: p.signed_area_x2)
     assert abs(result) == 150
 
 
-def test_rpolygon_signed_area(benchmark, rectilinear_polygon_points):
+def test_rpolygon_signed_area(benchmark, rectilinear_polygon_points) -> None:
     rp = RPolygon(rectilinear_polygon_points)
     result = benchmark(lambda: rp.signed_area)
     assert abs(result) == 75

{physdes_py-0.5 → physdes_py-0.7}/.flake8

@@ -1,3 +1,3 @@
 # Autoformatter friendly flake8 config (all formatting rules disabled)
 [flake8]
-extend-ignore = E1, E2, E3, E501, W1, W2, W3, W5
+extend-ignore = E1, E2, E3, E501, W1, W2, W3, W5, S314

physdes_py-0.7/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: 'Create a report to help us improve'
+title: '[BUG] <title>'
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+A clear and concise description of what actually happened.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment**
+- OS: [e.g., Windows, macOS, Linux]
+- Python version: [e.g., 3.8, 3.9, 3.10]
+- physdes-py version: [e.g., 0.1.0]
+- How did you install physdes-py?: [pip install, git clone, conda]
+
+**Additional context**
+Add any other context about the problem here.
+
+**Code snippet**
+If relevant, please provide a minimal code snippet that reproduces the issue:
+
+```python
+# Your code here
+```

physdes_py-0.7/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,29 @@
+---
+name: Documentation
+about: 'Suggest improvements or report issues with documentation'
+title: '[DOCS] <title>'
+
+---
+
+**Describe the documentation issue**
+A clear and concise description of what's wrong or what could be improved.
+
+**Which documentation?**
+Please specify which documentation has issue:
+- README.md
+- AGENTS.md
+- CONTRIBUTING.rst
+- API documentation (docs/)
+- Other (please specify)
+
+**What needs to be fixed/improved?**
+Describe what's missing, unclear, or incorrect.
+
+**Suggested fix**
+If you have a suggestion for how to improve documentation, please describe it here.
+
+**Screenshots (if applicable)**
+Add screenshots to help illustrate the documentation issue.
+
+**Additional context**
+Add any other context about the documentation issue here.

physdes_py-0.7/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: 'Suggest an idea for physdes-py'
+title: '[FEATURE] <title>'
+
+---
+
+**Is your feature request related to a problem? Please describe**
+A clear and concise description of what problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+
+**Use cases**
+Please describe specific use cases for this feature. This helps us understand how feature would be used in practice.
+
+Example use cases:
+- "When I'm working with X, I need Y because..."
+- "In my project, I want to implement Z, but I can't because..."

physdes_py-0.7/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,57 @@
+---
+name: Pull Request
+about: 'Create a pull request to contribute changes'
+
+---
+
+## Description
+Please include a summary of changes and motivation behind them.
+
+## Type of change
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Code refactoring (no functional changes, no API changes)
+- [ ] Other (please describe):
+
+## Related Issues
+Fixes #<issue_number>
+Related to #<issue_number>
+
+## How Has This Been Tested?
+Please describe the tests that you ran to verify your changes:
+- [ ] Unit tests added/updated
+- [ ] All existing tests pass
+- [ ] Manual testing performed (describe steps)
+- [ ] Tested on Python 3.8
+- [ ] Tested on Python 3.9
+- [ ] Tested on Python 3.10
+- [ ] Tested on Python 3.11
+- [ ] Tested on Python 3.12
+
+## Checklist:
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I have updated the CHANGELOG (if applicable) using towncrier
+
+## Additional Notes
+Add any other notes or context about the pull request here.
+
+### Breaking Changes
+If this PR introduces breaking changes, please describe them here:
+- API changes that may break existing code
+- Configuration changes
+- Migration steps needed
+
+### Performance Impact
+If this PR affects performance, please describe:
+- Benchmarks before
+- Benchmarks after
+- Performance improvements

{physdes_py-0.5 → physdes_py-0.7}/.github/workflows/multi-platforms.yml

@@ -8,10 +8,10 @@ jobs:
     strategy:
       matrix:
         os: ["ubuntu-latest", "windows-latest"]
-        version: ["3.10", "3.12"]
+        version: ["3.10", "3.11"]
     steps:
-      - uses: actions/checkout@v2
-      - uses: conda-incubator/setup-miniconda@v2
+      - uses: actions/checkout@v3
+      - uses: conda-incubator/setup-miniconda@v3
         with:
           activate-environment: test
           environment-file: environment.yml
@@ -31,9 +31,8 @@ jobs:
         shell: bash -l {0}
         run: |
           conda install pytest
-          python -m pip install --upgrade pip
+          conda install pip
+          conda install setuptools wheel setuptools_scm
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          pip install git+https://github.com/luk036/lds-gen.git
-          pip install git+https://github.com/luk036/mywheel.git
-          python setup.py develop
+          pip install -e .
           pytest

physdes_py-0.7/.github/workflows/python-app.yml

@@ -0,0 +1,89 @@
+# This workflow will install Python dependencies, run tests and lint with multiple Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python application
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+        os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.os }}
+    env:
+      FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest pytest-cov pytest-benchmark bandit safety
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install -e .
+          pip install pre-commit
+          # pip install mypy
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 188 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=188 --statistics
+
+      # - name: Type check with mypy
+      #   run: |
+      #     mypy src/physdes
+
+      # - name: Install and run pre-commit
+      #   env:
+      #     SKIP: no-commit-to-branch
+      #   run: |
+      #     pre-commit install
+      #     pre-commit run --all-files --show-diff-on-failure
+      #
+      # - name: Security scan with bandit
+      #   run: |
+      #     bandit -r src/ -f screen
+      #
+      # - name: Security check with safety
+      #   run: |
+      #     safety check --full-report
+
+      - name: Test with pytest
+        run: |
+          pytest --cov=src/ --cov-report=term-missing --cov-report=xml --cov-fail-under=80 -v
+
+      - name: Run benchmarks
+        run: |
+          pytest --benchmark-only --benchmark-autosave
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: true

{physdes_py-0.5 → physdes_py-0.7}/.gitignore

@@ -176,3 +176,16 @@ MANIFEST
 
 # my stuffs
 .hypothesis
+
+# Temporary log files
+*.log
+coverage.json
+mypy_error.log
+
+# Build artifacts
+diagram.bob
+oryx-build-commands.txt
+
+# Cache dirs
+.ruff_cache/
+.benchmarks/

{physdes_py-0.5 → physdes_py-0.7}/.pre-commit-config.yaml

@@ -14,8 +14,10 @@ repos:
       - id: debug-statements
       - id: end-of-file-fixer
       - id: requirements-txt-fixer
+        exclude: "requirements/dev[.]txt$"
       - id: mixed-line-ending
         args: ["--fix=auto"] # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+        exclude: "requirements[.]txt$"
 
   ## If you want to avoid flake8 errors due to unused vars or imports:
   # - repo: https://github.com/myint/autoflake

physdes_py-0.7/AGENTS.md

@@ -0,0 +1,273 @@
+# AGENTS.md - physdes-py
+
+This file guides agentic coding agents working in the physdes-py repository.
+
+## Build/Lint/Test Commands
+
+### Testing
+```bash
+# Run all tests
+pytest
+
+# Run single test
+pytest tests/test_module.py::test_function_name
+
+# Run with coverage (already enabled by default)
+pytest --cov physdes --cov-report term-missing
+
+# Run tests in specific directory
+pytest tests/test_point.py
+
+# Run with verbose output (default)
+pytest -v
+```
+
+### Linting/Formatting
+```bash
+# Run pre-commit hooks (includes isort, black, flake8)
+pre-commit run --all-files
+
+# Format code with black
+black src/physdes tests/
+
+# Sort imports with isort
+isort src/physdes tests/
+
+# Run flake8 linting
+flake8 src/physdes tests/
+```
+
+### Build
+```bash
+# Build package
+python -m build
+
+# Or using tox
+tox -e build
+```
+
+### Docs
+```bash
+# Build documentation
+sphinx-build -b html docs/ docs/_build/html
+```
+
+## Code Style Guidelines
+
+### Imports
+- **Standard library imports first**, then third-party, then project imports
+- Use explicit `from typing import` statements:
+  ```python
+  from typing import Any, Generic, TypeVar, Union, Optional, List, Tuple, Dict, Callable, TYPE_CHECKING
+  ```
+- Use relative imports for project modules:
+  ```python
+  from .generic import center, contain, displacement
+  from .interval import enlarge, hull
+  ```
+- For Python version compatibility (supports 3.8+):
+  ```python
+  if sys.version_info[:2] >= (3, 8):
+      from importlib.metadata import PackageNotFoundError, version
+  else:
+      from importlib_metadata import PackageNotFoundError, version
+  ```
+- Import debugging tools with `# type: ignore`:
+  ```python
+  from icecream import ic  # type: ignore
+  ```
+
+### Formatting
+- **Line length**: 188 characters (configured in setup.cfg)
+- **Formatter**: Black (version 23.7.0) with line length 188
+- **Import sorter**: isort (version 5.12.0)
+- **Linting**: flake8 with these exceptions: `E203, W503` (black-compatible)
+- **Line endings**: Mixed line endings fixed automatically via pre-commit
+
+### Type Hints
+- **Required**: All functions and methods must have type hints
+- **Generic types**: Use `TypeVar` and `Generic` for reusable classes:
+  ```python
+  T = TypeVar("T", int, float)
+  class Interval(Generic[T]):
+      def __init__(self, lb: T, ub: T) -> None: ...
+  ```
+- **Union types**: Use pipe syntax for Python 3.10+, `Union` for older:
+  ```python
+  def min_dist_with(self, obj: Union["Interval[T]", T]) -> T | int:
+  ```
+- **Forward references**: Use string quotes for types not yet defined:
+  ```python
+  def __lt__(self, other: "Point[T1, T2]") -> bool:
+  ```
+- **Ignore sparingly**: Use `# type: ignore` only when unavoidable (e.g., icecream, mywheel imports)
+
+### Naming Conventions
+- **Classes**: `PascalCase` (e.g., `Point`, `Interval`, `Vector2`)
+- **Functions/Methods**: `snake_case` (e.g., `hull_with`, `min_dist_with`, `get_center`)
+- **Variables**: `snake_case` (e.g., `xcoord`, `ycoord`, `lower_bound`)
+- **Constants**: `UPPER_SNAKE_CASE` (less common in this codebase)
+- **Properties**: Use `@property` for computed attributes:
+  ```python
+  @property
+  def lb(self) -> T:
+      return self._lb
+  ```
+- **Private attributes**: Prefix with underscore (e.g., `_lb`, `_ub`)
+
+### Operator Overloading
+- Implement dunder methods for mathematical operations:
+  ```python
+  def __add__(self, rhs: Union["Interval[T]", T]) -> "Interval[T]":
+  def __iadd__(self, rhs: Union["Interval[T]", T]) -> "Interval[T]":
+  def __lt__(self, other: Union["Interval[T]", T]) -> bool:
+  ```
+- Return `NotImplemented` for unsupported type comparisons:
+  ```python
+  def __eq__(self, other: object) -> bool:
+      if not isinstance(other, Point):
+          return NotImplemented
+      return (self.xcoord, self.ycoord) == (other.xcoord, other.ycoord)
+  ```
+
+### Documentation
+- **Docstrings required** for all public classes and methods
+- **Style**: Google-style or similar (examples show detailed parameter descriptions)
+- **Include**: Parameters, return types, and examples:
+  ```python
+  def hull_with(self, other: "Point[T1, T2]") -> "Point[Any, Any]":
+      """
+      The `hull_with` function takes another object and returns a new object
+      with the hull of the x and y coordinates of both objects.
+
+      :param other: The `other` parameter is an object of the same type as `self`.
+      :return: an instance of the same class as `self`.
+      """
+  ```
+- **Examples**: Use doctest format when appropriate:
+  ```python
+  Examples:
+      >>> a = Point(3, 5)
+      >>> print(a.hull_with(b))
+      ([3, 5], [4, 6])
+  ```
+- **ASCII art**: Use `svgbob` for geometric diagrams:
+  ```python
+  .. svgbob::
+     :align: center
+
+      .-----------.------.
+      | self      |      |
+      '-----------'      |
+  ```
+
+### Error Handling
+- **Minimal explicit error handling** - rely on Python's natural exceptions
+- **Use assertions** for preconditions:
+  ```python
+  assert lhs == rhs
+  ```
+- **Return invalid objects** when appropriate (e.g., `Interval` with `lb > ub`):
+  ```python
+  def is_invalid(self) -> bool:
+      return self.lb > self.ub
+  ```
+- Avoid empty catch blocks (`except: pass`)
+
+### Testing
+- **Framework**: pytest with doctest support enabled
+- **Coverage**: Required (--cov physdes --cov-report term-missing)
+- **Property-based testing**: Use hypothesis for complex algorithms
+- **Test naming**: `test_` prefix with descriptive names:
+  ```python
+  def test_point() -> None:
+  def test_displacement() -> None:
+  def test_hull() -> None:
+  ```
+- **Assertions**: Use plain `assert` statements
+- **Fixtures**: Use `conftest.py` for shared test data (random point generation)
+
+### Code Organization
+- **Structure**: `src/physdes/` for source, `tests/` for tests
+- **Namespace package**: Use `__init__.py` for version info
+- **Separation of concerns**: Core algorithms in dedicated modules (e.g., `dme_algorithm.py`, `global_router.py`)
+- **Utility functions**: Generic operations in `generic.py` that work with multiple types via `hasattr()` checks:
+  ```python
+  def overlap(lhs: Any, rhs: Any) -> bool:
+      if hasattr(lhs, "overlaps"):
+          result = lhs.overlaps(rhs)
+      elif hasattr(rhs, "overlaps"):
+          result = rhs.overlaps(lhs)
+      else:  # assume scalar
+          result = lhs == rhs
+      return bool(result)
+  ```
+
+### Pre-commit Hooks
+- **Required**: All code must pass pre-commit checks before committing
+- **Hooks configured**:
+  - `trailing-whitespace`
+  - `check-added-large-files`
+  - `check-ast`
+  - `check-merge-conflict`
+  - `isort`
+  - `black`
+  - `flake8`
+
+### Development Guidelines
+- **Python version**: Support 3.8+ (based on version checks in `__init__.py`)
+- **Dependencies**: Minimal external deps (mywheel, icecream, lds_gen for testing)
+- **Backward compatibility**: Use conditional imports for Python < 3.9
+- **Documentation**: Docstrings with parameter descriptions and examples
+- **Type safety**: Use type hints throughout, avoid `as any` or `@ts-ignore` equivalent
+
+### Example Class Template
+```python
+from typing import Any, Generic, TypeVar, Union
+
+T = TypeVar("T", int, float)
+
+
+class ClassName(Generic[T]):
+    """
+    Brief description of the class.
+
+    This code defines...
+    """
+
+    __slots__ = ("_attr1", "_attr2")
+
+    def __init__(self, attr1: T, attr2: T) -> None:
+        """
+        Initialize the object.
+
+        :param attr1: Description of attr1
+        :param attr2: Description of attr2
+        """
+        self._attr1: T = attr1
+        self._attr2: T = attr2
+
+    @property
+    def attr1(self) -> T:
+        """Return attr1 value."""
+        return self._attr1
+
+    def method_name(self, other: Any) -> Any:
+        """
+        Method description.
+
+        :param other: Description of parameter
+        :return: Description of return value
+        """
+        # Implementation
+        pass
+```
+
+## Key Project Context
+
+physdes-py implements VLSI physical design algorithms:
+- **Rectilinear polygons**: 2D/3D geometric operations
+- **Clock tree synthesis**: DME (Deferred Merge Embedding) algorithm
+- **Global routing**: Multiple strategies with constraints
+- **Steiner forests**: Grid-based routing algorithms
+- **Key dependencies**: `mywheel` (dllist), `lds_gen` (Halton sequences), `icecream` (debugging)

physdes_py-0.7/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## Version 0.7 (2026-07-16)
+
+### Performance
+- **`__slots__` on core geometry classes**: Added `__slots__` to `Point`, `ManhattanArc`, `Polygon`, `RPolygon`, `TreeNode`, `Sink` — saving ~176 bytes per instance. Most impactful on `Point` which is used everywhere in the codebase. (#64242a6)
+
+### Bug Fixes
+- **DME alignment with Rust**: Fixed elongation calculation with `raw_extend_left` to match Rust/C++. Replaced `sorted()` with median-partition in `build_merging_tree` (matches Rust `nth_element`). (#0267be3)
+- **NodeType rename**: Changed `ALL_CAPS` enum values to `PascalCase` to align with Rust naming conventions. (#0267be3)
+
+### Documentation
+- **Doc build scripts**: Updated remark and slide build scripts. Updated example plot scripts for RPolygon, CTS, and global router. (#0a613b3)
+
+### Code Cleanup
+- **Removed PyScaffold boilerplate**: Deleted `skeleton.py`/`test_skeleton.py`, removed Python < 3.9 compat, unused mypy ignores, stale files. (#e594991)

physdes_py-0.7/CHANGELOG.rst

@@ -0,0 +1,40 @@
+# Changelog
+===========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+This file is managed by towncrier. To add a changelog entry:
+
+1. Create a new file in `changelog/` directory:
+   - `changelog/<ISSUE_NUMBER>.<TYPE>.rst`
+   - Types: `feature`, `bugfix`, `doc`, `removal`, `misc`
+
+2. Write your change in markdown format using issue number
+
+Example: `changelog/123.feature.rst`
+```rst
+Add automated changelog management (#123)
+```
+
+3. The changelog will be automatically updated on next release
+
+## [Unreleased]
+
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+
+## Version 0.1
+==============
+
+- Initial release
+- Feature A added
+- FIX: nasty bug #1729 fixed
+- add your changes here!