amaranth-stubs 0.1.0__tar.gz

amaranth_stubs-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,105 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches:
+      - 'master'
+    tags:
+      - 'v**'
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    - name: Install pypa/build
+      run: python3 -m pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    if: ${{ github.repository == 'kuznia-rdzeni/amaranth-stubs' && github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v') && !contains(github.event.ref, 'dev') }}
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/amaranth-stubs
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    if: ${{ github.repository == 'kuznia-rdzeni/amaranth-stubs' && github.event_name == 'push' && github.event.ref == 'refs/heads/master' }}
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/amaranth-stubs
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+
+  github-release:
+    name: Github Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Determine release metadata
+      id: metadata
+      env:
+        REF_NAME: ${{ github.ref_name }}
+      run: |
+        echo name=${REF_NAME/v/} >>$GITHUB_OUTPUT
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: |
+        gh release create "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" --notes ""
+    - name: Upload to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run:
+        gh release upload "$GITHUB_REF_NAME" dist/** --repo "$GITHUB_REPOSITORY"
+

amaranth_stubs-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Build
+/build/
+
+# Egg
+*.egg-info
+
+# Editors
+*.swp

amaranth_stubs-0.1.0/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2022-2024, University of Wroclaw
+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 University of Wroclaw 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 UNIVERSITY OF WROCLAW 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.

amaranth_stubs-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: amaranth-stubs
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: amaranth==0.5.3
+Provides-Extra: dev
+Requires-Dist: pyright==1.1.332; extra == "dev"
+Dynamic: license-file

amaranth_stubs-0.1.0/amaranth-stubs/__init__.pyi

@@ -0,0 +1,7 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from .hdl import *
+
+__all__ = ["Shape", "unsigned", "signed", "Value", "Const", "C", "Mux", "Cat", "Array", "Signal", "ClockSignal", "ResetSignal", "Module", "ClockDomain", "Elaboratable", "Fragment", "Instance", "Memory", "Record", "DomainRenamer", "ResetInserter", "EnableInserter"]

amaranth_stubs-0.1.0/amaranth-stubs/_toolchain/yosys.pyi

@@ -0,0 +1,144 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+__all__ = ["YosysError", "YosysBinary", "find_yosys"]
+from typing import Optional
+from pathlib import Path
+
+
+class YosysError(Exception):
+    ...
+
+
+class YosysWarning(Warning):
+    ...
+
+
+class YosysBinary:
+    @classmethod
+    def available(cls) -> bool:
+        """Check for Yosys availability.
+
+        Returns
+        -------
+        available : bool
+            ``True`` if Yosys is installed, ``False`` otherwise. Installed binary may still not
+            be runnable, or might be too old to be useful.
+        """
+        ...
+    
+    @classmethod
+    def version(cls) -> Optional[tuple[int, int, int]]:
+        """Get Yosys version.
+
+        Returns
+        -------
+        ``None`` if version number could not be determined, or a 3-tuple ``(major, minor, distance)`` if it could.
+
+        major : int
+            Major version.
+        minor : int
+            Minor version.
+        distance : int
+            Distance to last tag per ``git describe``. May not be exact for system Yosys.
+        """
+        ...
+    
+    @classmethod
+    def data_dir(cls) -> Path:
+        """Get Yosys data directory.
+
+        Returns
+        -------
+        data_dir : pathlib.Path
+            Yosys data directory (also known as "datdir").
+        """
+        ...
+    
+    @classmethod
+    def run(cls, args: list[str], stdin: str=...) -> str:
+        """Run Yosys process.
+
+        Parameters
+        ----------
+        args : list of str
+            Arguments, not including the program name.
+        stdin : str
+            Standard input.
+
+        Returns
+        -------
+        stdout : str
+            Standard output.
+
+        Exceptions
+        ----------
+        YosysError
+            Raised if Yosys returns a non-zero code. The exception message is the standard error
+            output.
+        """
+        ...
+    
+
+
+class _BuiltinYosys(YosysBinary):
+    YOSYS_PACKAGE = ...
+    @classmethod
+    def available(cls): # -> bool:
+        ...
+    
+    @classmethod
+    def version(cls): # -> tuple[int, int, int]:
+        ...
+    
+    @classmethod
+    def data_dir(cls): # -> Traversable:
+        ...
+    
+    @classmethod
+    def run(cls, args, stdin=..., *, ignore_warnings=..., src_loc_at=...):
+        ...
+    
+
+
+class _SystemYosys(YosysBinary):
+    YOSYS_BINARY = ...
+    @classmethod
+    def available(cls) -> bool:
+        ...
+    
+    @classmethod
+    def version(cls): # -> tuple[int, int, int] | None:
+        ...
+    
+    @classmethod
+    def data_dir(cls) -> Path:
+        ...
+    
+    @classmethod
+    def run(cls, args, stdin=..., *, ignore_warnings=..., src_loc_at=...):
+        ...
+    
+
+
+def find_yosys(requirement):
+    """Find an available Yosys executable of required version.
+
+    Parameters
+    ----------
+    requirement : function
+        Version check. Should return ``True`` if the version is acceptable, ``False`` otherwise.
+
+    Returns
+    -------
+    yosys_binary : subclass of YosysBinary
+        Proxy for running the requested version of Yosys.
+
+    Exceptions
+    ----------
+    YosysError
+        Raised if required Yosys version is not found.
+    """
+    ...
+

amaranth_stubs-0.1.0/amaranth-stubs/_unused.pyi

@@ -0,0 +1,13 @@
+import sys
+import warnings
+
+__all__ = ["UnusedMustUse", "MustUse"]
+
+
+class UnusedMustUse(Warning):
+    pass
+
+
+class MustUse:
+    _MustUse__silence : bool
+    _MustUse__warning : UnusedMustUse

amaranth_stubs-0.1.0/amaranth-stubs/_utils.pyi

@@ -0,0 +1,27 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+__all__ = ["flatten", "union", "memoize", "final", "deprecated", "get_linter_options", "get_linter_option"]
+
+def flatten(i): # -> Generator[str | Unknown, Unknown, None]:
+    ...
+
+def union(i, start=...): # -> None:
+    ...
+
+def memoize(f): # -> _Wrapped[..., Unknown, (*args: Unknown), Unknown]:
+    ...
+
+def final(cls):
+    ...
+
+def deprecated(message, stacklevel=...): # -> (f: Unknown) -> _Wrapped[..., Unknown, (*args: Unknown, **kwargs: Unknown), Unknown]:
+    ...
+
+def get_linter_options(filename): # -> dict[str, str] | dict[Unknown, Unknown]:
+    ...
+
+def get_linter_option(filename, name, type, default): # -> int | bool:
+    ...
+

amaranth_stubs-0.1.0/amaranth-stubs/asserts.pyi

@@ -0,0 +1,4 @@
+"""
+This type stub file was generated by pyright.
+"""
+

amaranth_stubs-0.1.0/amaranth-stubs/back/__init__.pyi

@@ -0,0 +1,4 @@
+"""
+This type stub file was generated by pyright.
+"""
+

amaranth_stubs-0.1.0/amaranth-stubs/back/verilog.pyi

@@ -0,0 +1,14 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from .._toolchain.yosys import *
+from ..hdl._ast import SignalDict
+
+__all__ = ["YosysError", "convert", "convert_fragment"]
+def convert_fragment(*args, strip_internal_attrs=..., **kwargs) -> tuple[str, SignalDict]:
+    ...
+
+def convert(elaboratable, name=..., platform=..., *, ports=..., emit_src=..., strip_internal_attrs=..., **kwargs) -> str:
+    ...
+

amaranth_stubs-0.1.0/amaranth-stubs/build/__init__.pyi

@@ -0,0 +1,8 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from .dsl import *
+from .res import ResourceError
+from .plat import *
+

amaranth_stubs-0.1.0/amaranth-stubs/build/dsl.pyi

@@ -0,0 +1,107 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from collections import OrderedDict
+from collections.abc import Iterator, Mapping
+from typing import Optional
+
+__all__ = ["Pins", "PinsN", "DiffPairs", "DiffPairsN", "Attrs", "Clock", "Subsignal", "Resource", "Connector"]
+class Pins:
+    def __init__(self, names: str, *, dir: str=..., invert: bool=..., conn: Optional[tuple[str, int|str]]=..., assert_width: Optional[int]=...) -> None:
+        ...
+    
+    def __len__(self) -> int:
+        ...
+    
+    def __iter__(self) -> Iterator[str]:
+        ...
+    
+    def map_names(self, mapping: Mapping[str, str], resource) -> list[str]:
+        ...
+    
+    def __repr__(self) -> str:
+        ...
+    
+
+
+def PinsN(*args, **kwargs) -> Pins:
+    ...
+
+class DiffPairs:
+    def __init__(self, p: str, n: str, *, dir: str=..., invert: bool=..., conn: Optional[tuple[str, int|str]]=..., assert_width: Optional[int]=...) -> None:
+        ...
+    
+    def __len__(self) -> int:
+        ...
+    
+    def __iter__(self) -> Iterator[tuple[str, str]]:
+        ...
+    
+    def __repr__(self) -> str:
+        ...
+    
+
+
+def DiffPairsN(*args, **kwargs) -> DiffPairs:
+    ...
+
+class Attrs(OrderedDict):
+    def __init__(self, **attrs) -> None:
+        ...
+    
+    def __repr__(self) -> str:
+        ...
+    
+
+
+class Clock:
+    def __init__(self, frequency: float | int) -> None:
+        ...
+    
+    @property
+    def period(self) -> float:
+        ...
+    
+    def __repr__(self) -> str:
+        ...
+    
+
+
+class Subsignal:
+    def __init__(self, name: str, *args: Pins | DiffPairs | Subsignal | Attrs | Clock) -> None:
+        ...
+    
+    def __repr__(self) -> str:
+        ...
+    
+
+
+class Resource(Subsignal):
+    @classmethod
+    def family(cls, name_or_number: str | int, number: Optional[int]=..., *, ios, default_name: str, name_suffix: str=...): # -> Self@Resource:
+        ...
+    
+    def __init__(self, name, number, *args) -> None:
+        ...
+    
+    def __repr__(self) -> str:
+        ...
+    
+
+
+class Connector:
+    def __init__(self, name: str, number: int, io: str | dict[str, str], *, conn: Optional[tuple[str, int|str]]=...) -> None:
+        ...
+    
+    def __repr__(self) -> str:
+        ...
+    
+    def __len__(self) -> int:
+        ...
+    
+    def __iter__(self) -> Iterator[tuple[str, str]]:
+        ...
+    
+
+

amaranth_stubs-0.1.0/amaranth-stubs/build/plat.pyi

@@ -0,0 +1,102 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from abc import ABCMeta, abstractmethod
+from .._toolchain import *
+from ..hdl import *
+from .res import *
+from .run import *
+
+__all__ = ["Platform", "TemplatedPlatform"]
+class Platform(ResourceManager, metaclass=ABCMeta):
+    resources = ...
+    connectors = ...
+    default_clk = ...
+    default_rst = ...
+    required_tools = ...
+    def __init__(self) -> None:
+        ...
+    
+    @property
+    def default_clk_constraint(self):
+        ...
+    
+    @property
+    def default_clk_frequency(self):
+        ...
+    
+    def add_file(self, filename, content): # -> None:
+        ...
+    
+    def iter_files(self, *suffixes): # -> Generator[Unknown, Any, None]:
+        ...
+    
+    def build(self, elaboratable, name=..., build_dir=..., do_build=..., program_opts=..., do_program=..., **kwargs): # -> None:
+        ...
+    
+    def has_required_tools(self): # -> bool:
+        ...
+    
+    def create_missing_domain(self, name): # -> Module | None:
+        ...
+    
+    def prepare(self, elaboratable, name=..., **kwargs):
+        ...
+
+    def iter_port_constraints_bits(self):
+        ...
+
+    @abstractmethod
+    def toolchain_prepare(self, fragment, name, **kwargs):
+        """
+        Convert the ``fragment`` and constraints recorded in this :class:`Platform` into
+        a :class:`BuildPlan`.
+        """
+        ...
+    
+    def toolchain_program(self, products, name, **kwargs):
+        """
+        Extract bitstream for fragment ``name`` from ``products`` and download it to a target.
+        """
+        ...
+    
+    def get_input(self, pin, port, attrs, invert): # -> Module:
+        ...
+    
+    def get_output(self, pin, port, attrs, invert): # -> Module:
+        ...
+    
+    def get_tristate(self, pin, port, attrs, invert): # -> Module:
+        ...
+    
+    def get_input_output(self, pin, port, attrs, invert): # -> Module:
+        ...
+    
+    def get_diff_input(self, pin, port, attrs, invert): # -> None:
+        ...
+    
+    def get_diff_output(self, pin, port, attrs, invert): # -> None:
+        ...
+    
+    def get_diff_tristate(self, pin, port, attrs, invert): # -> None:
+        ...
+    
+    def get_diff_input_output(self, pin, port, attrs, invert): # -> None:
+        ...
+    
+
+
+class TemplatedPlatform(Platform):
+    toolchain = ...
+    file_templates = ...
+    command_templates = ...
+    build_script_templates = ...
+    def iter_clock_constraints(self): # -> Generator[tuple[Unknown, Unknown | None, Unknown], Any, None]:
+        ...
+    
+    def toolchain_prepare(self, fragment, name, **kwargs): # -> BuildPlan:
+        ...
+    
+
+

amaranth_stubs-0.1.0/amaranth-stubs/build/res.pyi

@@ -0,0 +1,53 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from typing import Any
+from ..hdl._ast import *
+from ..hdl.rec import *
+from ..lib.io import *
+from .dsl import *
+from collections.abc import Iterable, Iterator
+
+__all__ = ["ResourceError", "ResourceManager"]
+class ResourceError(Exception):
+    ...
+
+
+class PortGroup:
+    ...
+
+
+class ResourceManager:
+    def __init__(self, resources: Iterable[Resource], connectors: Iterable[Connector]) -> None:
+        ...
+    
+    def add_resources(self, resources: Iterable[Resource]) -> None:
+        ...
+    
+    def add_connectors(self, connectors: Iterable[Connector]) -> None:
+        ...
+    
+    def lookup(self, name: str, number: int=...) -> Resource:
+        ...
+    
+    def request(self, name: str, number: int=..., *, dir=..., xdr=...) -> Pin | PortLike | PortGroup:
+        ...
+    
+    def iter_single_ended_pins(self): # -> Generator[tuple[Unknown, Unknown, Unknown, Unknown], Any, None]:
+        ...
+    
+    def iter_differential_pins(self): # -> Generator[tuple[Unknown, Unknown, Unknown, Unknown], Any, None]:
+        ...
+    
+    def should_skip_port_component(self, port, attrs, component) -> bool:
+        ...
+    
+    def add_clock_constraint(self, clock: Signal, frequency: int | float) -> None:
+        ...
+    
+    def iter_clock_constraints(self) -> Iterator[tuple[Signal, Any, int | float]]:
+        ...
+    
+
+