Merge pull request #78 from FoamyGuy/update_frequency

Use higher frequency values
2025-07-25 13:26:07 -07:00 · 2025-07-25 10:54:49 -05:00 · 2025-06-17 10:31:22 -05:00 · 2025-05-16 13:40:01 -05:00 · 2025-05-16 18:31:52 +00:00 · 2025-01-23 16:41:06 -06:00
38 changed files with 345 additions and 571 deletions
--- a/.gitattributes
+++ b/.gitattributes
@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+.py text eol=lf
+.rst text eol=lf
+.txt text eol=lf
+.yaml text eol=lf
+.toml text eol=lf
+.license text eol=lf
+.md text eol=lf
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@ -1,42 +1,21 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense

 repos:
-  - repo: https://github.com/python/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v1.1.2
-    hooks:
-      - id: reuse
  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
    hooks:
      - id: check-yaml
      - id: end-of-file-fixer
      - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.17.4
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
    hooks:
-      - id: pylint
-        name: pylint (library code)
-        types: [python]
-        args:
-          - --disable=consider-using-f-string
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
-      - id: pylint
-        name: pylint (example code)
-        description: Run pylint rules on "examples/*.py" files
-        types: [python]
-        files: "^examples/"
-        args:
-          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-      - id: pylint
-        name: pylint (test code)
-        description: Run pylint rules on "tests/*.py" files
-        types: [python]
-        files: "^tests/"
-        args:
-          - --disable=missing-docstring,consider-using-f-string,duplicate-code
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
+    hooks:
+      - id: reuse
--- a/.pylintrc
+++ b/.pylintrc
@ -1,399 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
-
-[MASTER]
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code
-extension-pkg-whitelist=
-
-# Add files or directories to the ignore-list. They should be base names, not
-# paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the ignore-list. The
-# regex matches against base names, not paths.
-ignore-patterns=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint.
-jobs=1
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=pylint.extensions.no_self_use
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# Specify a configuration file.
-#rcfile=
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
-confidence=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
-# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call
-disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=
-
-
-[REPORTS]
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-#msg-template=
-
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio).You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Tells whether to display a full report or only the messages
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-
-[LOGGING]
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format
-logging-modules=logging
-
-
-[SPELLING]
-
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to indicated private dictionary in
-# --spelling-private-dict-file option instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-# notes=FIXME,XXX,TODO
-notes=FIXME,XXX
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis. It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=board
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,_cb
-
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,future.builtins
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-# expected-line-ending-format=
-expected-line-ending-format=LF
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Number of spaces of indent required inside a hanging  or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[SIMILARITIES]
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=yes
-
-# Minimum lines number of a similarity.
-min-similarity-lines=12
-
-
-[BASIC]
-
-# Regular expression matching correct argument names
-argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct attribute names
-attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression matching correct class names
-# class-rgx=[A-Z_][a-zA-Z0-9]+$
-class-rgx=[A-Z_][a-zA-Z0-9_]+$
-
-# Regular expression matching correct constant names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Regular expression matching correct function names
-function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Good variable names which should always be accepted, separated by a comma
-# good-names=i,j,k,ex,Run,_
-good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
-
-# Include a hint for the correct naming format with invalid-name
-include-naming-hint=no
-
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Regular expression matching correct method names
-method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-property-classes=abc.abstractproperty
-
-# Regular expression matching correct variable names
-variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-
-[IMPORTS]
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=optparse,tkinter.tix
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-
-[CLASSES]
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Maximum number of attributes for a class (see R0902).
-# max-attributes=7
-max-attributes=11
-
-# Maximum number of boolean expressions in a if statement
-max-bool-expr=5
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=1
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=builtins.Exception
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@ -8,8 +8,11 @@
 # Required
 version: 2

+sphinx:
+  configuration: docs/conf.py
+
 build:
-  os: ubuntu-20.04
+  os: ubuntu-lts-latest
  tools:
    python: "3"

--- a/README.rst
+++ b/README.rst
@ -13,9 +13,9 @@ Introduction
    :target: https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/actions
    :alt: Build Status

-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: Ruff

 Simple assembler to convert pioasm to bytes

@ -75,7 +75,7 @@ Usage Example

    sm = rp2pio.StateMachine(
        assembled,
-        frequency=2000,
+        frequency=4000,
        init=adafruit_pioasm.assemble("set pindirs 1"),
        first_set_pin=board.LED,
    )
--- a/adafruit_pioasm.py
+++ b/adafruit_pioasm.py
@ -12,7 +12,7 @@ Simple assembler to convert pioasm to bytes
 """

 try:
-    from typing import List, MutableSequence
+    from typing import Any, List, Sequence
 except ImportError:
    pass

@ -45,7 +45,7 @@ FIFO_TYPES = {
 }


-class Program:  # pylint: disable=too-few-public-methods
+class Program:
    """Encapsulates a program's instruction stream and configuration flags

    Example::
@ -55,16 +55,24 @@ class Program:  # pylint: disable=too-few-public-methods

    """

+    assembled: array.array
+    """The assembled PIO program instructions"""
+    public_labels: dict[str, int]
+    """The offset of any labels declared public"""
+    pio_kwargs: dict[str, Any]
+    """Settings from assembler directives to pass to the StateMachine constructor"""
+
    def __init__(self, text_program: str, *, build_debuginfo: bool = False) -> None:
        """Converts pioasm text to encoded instruction bytes"""
-        # pylint: disable=too-many-branches,too-many-statements,too-many-locals
        assembled: List[int] = []
        program_name = None
        labels = {}
+        public_labels = {}
        linemap = []
        instructions: List[str] = []
        sideset_count = 0
        sideset_enable = 0
+        sideset_pindirs = False
        wrap = None
        wrap_target = None
        offset = -1
@ -88,23 +96,17 @@ class Program:  # pylint: disable=too-few-public-methods

        def require_version(required_version, instruction):
            if pio_version < required_version:
-                raise RuntimeError(
-                    f"{instruction} requires .pio_version {required_version}"
-                )
+                raise RuntimeError(f"{instruction} requires .pio_version {required_version}")

        def int_in_range(arg, low, high, what, radix=0):
            result = int(arg, radix)
            if low <= result < high:
                return result
-            raise RuntimeError(
-                f"{what} must be at least {low} and less than {high}, got {result}"
-            )
+            raise RuntimeError(f"{what} must be at least {low} and less than {high}, got {result}")

        def parse_rxfifo_brackets(arg, fifo_dir):
            require_version(1, line)
-            if (  # pylint: disable=consider-using-in
-                fifo_type != "putget" and fifo_type != fifo_dir
-            ):
+            if fifo_type != "putget" and fifo_type != fifo_dir:
                raise RuntimeError(
                    f"FIFO must be configured for '{fifo_dir}' or 'putget' for {line}"
                )
@ -136,6 +138,7 @@ class Program:  # pylint: disable=too-few-public-methods
            elif line.startswith(".side_set"):
                sideset_count = int(line.split()[1], 0)
                sideset_enable = "opt" in line
+                sideset_pindirs = "pindirs" in line
            elif line.startswith(".fifo"):
                require_before_instruction()
                fifo_type = line.split()[1]
@ -148,7 +151,7 @@ class Program:  # pylint: disable=too-few-public-methods
                required_version = 0
                mov_status_n = 0
                mov_status_type = words[1]
-                if words[1] in ("txfifo", "rxfifo"):
+                if words[1] in {"txfifo", "rxfifo"}:
                    if words[2] != "<":
                        raise RuntimeError(f"Invalid {line}")
                    mov_status_n = int_in_range(words[3], 0, 32, words[1])
@ -190,9 +193,7 @@ class Program:  # pylint: disable=too-few-public-methods

            elif words[0] == ".in":
                require_before_instruction()
-                in_count = int_in_range(
-                    words[1], 32 if pio_version == 0 else 1, 33, ".in count"
-                )
+                in_count = int_in_range(words[1], 32 if pio_version == 0 else 1, 33, ".in count")
                auto_push = False

                idx = 2
@ -213,12 +214,13 @@ class Program:  # pylint: disable=too-few-public-methods

            elif words[0] == ".set":
                require_before_instruction()
-                set_count = int_in_range(
-                    words[1], 5 if pio_version == 0 else 1, 6, ".set count"
-                )
+                set_count = int_in_range(words[1], 5 if pio_version == 0 else 1, 6, ".set count")

            elif line.endswith(":"):
                label = line[:-1]
+                if line.startswith("public "):
+                    label = label[7:]
+                    public_labels[label] = len(instructions)
                if label in labels:
                    raise SyntaxError(f"Duplicate label {repr(label)}")
                labels[label] = len(instructions)
@ -227,6 +229,7 @@ class Program:  # pylint: disable=too-few-public-methods
                instructions.append(line)
                linemap.append(i)

+        mov_destinations: Sequence[str | None]
        if pio_version >= 1:
            mov_destinations = MOV_DESTINATIONS_V1
        else:
@ -234,7 +237,7 @@ class Program:  # pylint: disable=too-few-public-methods

        max_delay = 2 ** (5 - sideset_count - sideset_enable) - 1
        assembled = []
-        for line in instructions:  # pylint: disable=too-many-nested-blocks
+        for line in instructions:
            instruction = splitter(line.strip())
            delay = 0
            if (
@ -277,9 +280,7 @@ class Program:  # pylint: disable=too-few-public-methods
                    try:
                        assembled[-1] |= CONDITIONS.index(instruction[1]) << 5
                    except ValueError as exc:
-                        raise ValueError(
-                            f"Invalid jmp condition '{instruction[1]}'"
-                        ) from exc
+                        raise ValueError(f"Invalid jmp condition '{instruction[1]}'") from exc

            elif instruction[0] == "wait":
                #                instr delay p sr index
@ -320,9 +321,7 @@ class Program:  # pylint: disable=too-few-public-methods
                            assembled[-1] |= 0b10000
                    else:
                        limit = 32
-                    num = int_in_range(
-                        instruction[idx], 0, limit, "wait {instruction[2]}"
-                    )
+                    num = int_in_range(instruction[idx], 0, limit, "wait {instruction[2]}")
                    assembled[-1] |= num

            elif instruction[0] == "in":
@ -344,9 +343,7 @@ class Program:  # pylint: disable=too-few-public-methods
                try:
                    assembled[-1] |= OUT_DESTINATIONS.index(destination) << 5
                except ValueError as exc:
-                    raise ValueError(
-                        f"Invalid out destination '{destination}'"
-                    ) from exc
+                    raise ValueError(f"Invalid out destination '{destination}'") from exc
                count = int(instruction[-1], 0)
                if not 1 <= count <= 32:
                    raise RuntimeError("Count out of range")
@ -358,7 +355,7 @@ class Program:  # pylint: disable=too-few-public-methods
                    assembled[-1] |= 0x80
                if instruction[-1] == "block" or not instruction[-1].endswith("block"):
                    assembled[-1] |= 0x20
-                if len(instruction) > 1 and instruction[1] in ("ifempty", "iffull"):
+                if len(instruction) > 1 and instruction[1] in {"ifempty", "iffull"}:
                    assembled[-1] |= 0x40
            elif instruction[0] == "mov":
                #                instr delay dst op src
@ -434,9 +431,7 @@ class Program:  # pylint: disable=too-few-public-methods
                try:
                    assembled[-1] |= SET_DESTINATIONS.index(instruction[1]) << 5
                except ValueError as exc:
-                    raise ValueError(
-                        f"Invalid set destination '{instruction[1]}'"
-                    ) from exc
+                    raise ValueError(f"Invalid set destination '{instruction[1]}'") from exc
                value = int(instruction[-1], 0)
                if not 0 <= value <= 31:
                    raise RuntimeError("Set value out of range")
@ -458,6 +453,8 @@ class Program:  # pylint: disable=too-few-public-methods

        if sideset_count != 0:
            self.pio_kwargs["sideset_pin_count"] = sideset_count
+        if sideset_pindirs:
+            self.pio_kwargs["sideset_pindirs"] = sideset_pindirs

        if wrap is not None:
            self.pio_kwargs["wrap"] = wrap
@ -474,7 +471,7 @@ class Program:  # pylint: disable=too-few-public-methods
        if set_count is not None:
            self.pio_kwargs["set_pin_count"] = set_count

-        if out_count not in (None, 32):
+        if out_count not in {None, 32}:
            self.pio_kwargs["out_pin_count"] = out_count

        if out_shift_right is not None:
@ -486,7 +483,7 @@ class Program:  # pylint: disable=too-few-public-methods
        if pull_threshold is not None:
            self.pio_kwargs["pull_threshold"] = pull_threshold

-        if in_count not in (None, 32):
+        if in_count not in {None, 32}:
            self.pio_kwargs["in_pin_count"] = in_count

        if in_shift_right is not None:
@ -502,10 +499,12 @@ class Program:  # pylint: disable=too-few-public-methods

        self.debuginfo = (linemap, text_program) if build_debuginfo else None

+        self.public_labels = public_labels
+
    @classmethod
    def from_file(cls, filename: str, **kwargs) -> "Program":
        """Assemble a PIO program in a file"""
-        with open(filename, "r", encoding="utf-8") as i:
+        with open(filename, encoding="utf-8") as i:
            program = i.read()
        return cls(program, **kwargs)

@ -521,14 +520,10 @@ class Program:  # pylint: disable=too-few-public-methods
        print(
            f"{qualifier} int {name}_wrap = {self.pio_kwargs.get('wrap', len(self.assembled)-1)};"
        )
-        print(
-            f"{qualifier} int {name}_wrap_target = {self.pio_kwargs.get('wrap_target', 0)};"
-        )
+        print(f"{qualifier} int {name}_wrap_target = {self.pio_kwargs.get('wrap_target', 0)};")
        sideset_pin_count = self.pio_kwargs.get("sideset_pin_count", 0)
        print(f"{qualifier} int {name}_sideset_pin_count = {sideset_pin_count};")
-        print(
-            f"{qualifier} bool {name}_sideset_enable = {self.pio_kwargs['sideset_enable']};"
-        )
+        print(f"{qualifier} bool {name}_sideset_enable = {+self.pio_kwargs['sideset_enable']};")
        print(f"{qualifier} uint16_t {name}[] = " + "{")
        last_line = 0
        if linemap:
@ -550,14 +545,12 @@ class Program:  # pylint: disable=too-few-public-methods
                last_line += 1
        else:
            for i in range(0, len(self.assembled), 8):
-                print(
-                    "    " + ", ".join("0x%04x" % i for i in self.assembled[i : i + 8])
-                )
+                print("    " + ", ".join("0x%04x" % i for i in self.assembled[i : i + 8]))
        print("};")
        print()


-def assemble(program_text: str) -> MutableSequence[int]:
+def assemble(program_text: str) -> array.array:
    """Converts pioasm text to encoded instruction bytes

    In new code, prefer to use the `Program` class so that the extra arguments
--- a/docs/api.rst
+++ b/docs/api.rst
@ -4,5 +4,8 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"

+API Reference
+#############
+
 .. automodule:: adafruit_pioasm
   :members:
--- a/docs/conf.py
+++ b/docs/conf.py
@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT

+import datetime
 import os
 import sys
-import datetime

 sys.path.insert(0, os.path.abspath(".."))

@ -51,9 +49,7 @@ project = "Adafruit PIOASM Library"
 creation_year = "2021"
 current_year = str(datetime.datetime.now().year)
 year_duration = (
-    current_year
-    if current_year == creation_year
-    else creation_year + " - " + current_year
+    current_year if current_year == creation_year else creation_year + " - " + current_year
 )
 copyright = year_duration + " Scott Shawcroft"
 author = "Scott Shawcroft"
@ -113,7 +109,6 @@ napoleon_numpy_docstring = False
 import sphinx_rtd_theme

 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
--- a/examples/pioasm_7seg.py
+++ b/examples/pioasm_7seg.py
@ -39,8 +39,10 @@ Wiring:

 import array
 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm

 _program = adafruit_pioasm.Program(
@ -114,7 +116,7 @@ class SMSevenSegment:
        self._buf = array.array("H", (DIGITS_WT[0] & ~COM_WT[i] for i in range(4)))
        self._sm = rp2pio.StateMachine(
            _program.assembled,
-            frequency=2000,
+            frequency=4000,
            first_out_pin=first_pin,
            out_pin_count=14,
            auto_pull=True,
--- a/examples/pioasm_7seg_fader.py
+++ b/examples/pioasm_7seg_fader.py
@ -36,12 +36,14 @@ Wiring:
 * Pico GP16 to LED matrix 14 (COM1)
 """

+import array
 import asyncio
 import random
-import array
+
 import board
 import rp2pio
 from ulab import numpy as np
+
 import adafruit_pioasm

 _pio_source = """
@ -130,20 +132,16 @@ def make_digit_wt(v):


 class LedFader:
-    def __init__(
-        self, first_pin, pin_count, cathode_weights, anode_weights, levels=64
-    ):  # pylint: disable=too-many-arguments
+    def __init__(self, first_pin, pin_count, cathode_weights, anode_weights, levels=64):
        self._cathode_weights = cathode_weights
        self._anode_weights = anode_weights
-        self._stream = array.array("L", [0, 0, 1]) * (
-            1 + len(cathode_weights) * len(anode_weights)
-        )
+        self._stream = array.array("L", [0, 0, 1]) * (1 + len(cathode_weights) * len(anode_weights))
        self._levels = levels
        self._max_count = levels * len(self)
        self._total = len(self)

        program = adafruit_pioasm.Program(_pio_source.format(n=pin_count))
-        self._sm = rp2pio.StateMachine(  # pylint: disable=too-many-arguments
+        self._sm = rp2pio.StateMachine(
            program.assembled,
            frequency=125_000_000,
            first_out_pin=first_pin,
@ -152,9 +150,7 @@ class LedFader:
            pull_threshold=14,
            **program.pio_kwargs,
        )
-        print(
-            f"Note: approximate refresh rate {self._sm.frequency / self._max_count:.0f}Hz"
-        )
+        print(f"Note: approximate refresh rate {self._sm.frequency / self._max_count:.0f}Hz")
        self._sm.background_write(loop=self._stream)

    def __enter__(self):
--- a/examples/pioasm_background_morse.py
+++ b/examples/pioasm_background_morse.py
@ -19,8 +19,10 @@ https://en.wikipedia.org/wiki/Morse_code

 import array
 import time
+
 from board import LED
 from rp2pio import StateMachine
+
 from adafruit_pioasm import Program

 # This program turns the LED on or off depending on the first bit of the value,
@ -73,7 +75,7 @@ sm = StateMachine(
 )

 # To simply repeat 'TEST' forever, change to 'if True':
-if False:  # pylint: disable=using-constant-test
+if False:
    print("Sending out TEST forever", end="")
    sm.background_write(loop=TEST)
    while True:
--- a/examples/pioasm_blink.py
+++ b/examples/pioasm_blink.py
@ -6,8 +6,10 @@

 import array
 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm

 blink = adafruit_pioasm.assemble(
--- a/examples/pioasm_hello.py
+++ b/examples/pioasm_hello.py
@ -5,8 +5,10 @@
 # Adapted from the example https://github.com/raspberrypi/pico-examples/tree/master/pio/hello_pio

 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm

 hello = """
@ -25,7 +27,7 @@ assembled = adafruit_pioasm.assemble(hello)

 sm = rp2pio.StateMachine(
    assembled,
-    frequency=2000,
+    frequency=4000,
    first_out_pin=board.LED,
 )
 print("real frequency", sm.frequency)
--- a/examples/pioasm_i2s_codec.py
+++ b/examples/pioasm_i2s_codec.py
@ -2,6 +2,7 @@
 # SPDX-License-Identifier: MIT

 import array
+
 import board
 import rp2pio

@ -86,7 +87,7 @@ import adafruit_pioasm
 #  read: 00000000  00000000  00000000  00000000  00000000  00000000  00000000  00000000


-def i2s_codec(  # pylint: disable=too-many-arguments
+def i2s_codec(
    channels=2,
    sample_rate=48000,
    bits=16,
--- a/examples/pioasm_i2sout.py
+++ b/examples/pioasm_i2sout.py
@ -5,9 +5,11 @@
 import array
 import math
 import time
+
 import board
 import digitalio
 import rp2pio
+
 import adafruit_pioasm

 trigger = digitalio.DigitalInOut(board.D4)
--- a/examples/pioasm_led_brightness.py
+++ b/examples/pioasm_led_brightness.py
@ -5,8 +5,10 @@
 # Adapted from the an example in Appendix C of RPi_PiPico_Digital_v10.pdf

 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm

 led_quarter_brightness = adafruit_pioasm.assemble(
@ -30,20 +32,14 @@ led_full_brightness = adafruit_pioasm.assemble(
 )

 while True:
-    sm = rp2pio.StateMachine(
-        led_quarter_brightness, frequency=10000, first_set_pin=board.LED
-    )
+    sm = rp2pio.StateMachine(led_quarter_brightness, frequency=10000, first_set_pin=board.LED)
    time.sleep(1)
    sm.deinit()

-    sm = rp2pio.StateMachine(
-        led_half_brightness, frequency=10000, first_set_pin=board.LED
-    )
+    sm = rp2pio.StateMachine(led_half_brightness, frequency=10000, first_set_pin=board.LED)
    time.sleep(1)
    sm.deinit()

-    sm = rp2pio.StateMachine(
-        led_full_brightness, frequency=10000, first_set_pin=board.LED
-    )
+    sm = rp2pio.StateMachine(led_full_brightness, frequency=10000, first_set_pin=board.LED)
    time.sleep(1)
    sm.deinit()
--- a/examples/pioasm_neopixel.py
+++ b/examples/pioasm_neopixel.py
@ -3,9 +3,11 @@
 # SPDX-License-Identifier: MIT

 import time
-import rp2pio
+
 import board
 import microcontroller
+import rp2pio
+
 import adafruit_pioasm

 # NeoPixels are 800khz bit streams. We are choosing zeros as <312ns hi, 936 lo>
--- a/examples/pioasm_neopixel_bg.py
+++ b/examples/pioasm_neopixel_bg.py
@ -23,8 +23,10 @@ pattern across all the LEDs.
 """

 import struct
+
 import adafruit_pixelbuf
 from rp2pio import StateMachine
+
 from adafruit_pioasm import Program

 # Pixel color order constants
@ -66,12 +68,8 @@ wait_reset:
 )


-class NeoPixelBackground(  # pylint: disable=too-few-public-methods
-    adafruit_pixelbuf.PixelBuf
-):
-    def __init__(
-        self, pin, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None
-    ):
+class NeoPixelBackground(adafruit_pixelbuf.PixelBuf):
+    def __init__(self, pin, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None):
        if not pixel_order:
            pixel_order = GRB if bpp == 3 else GRBW
        elif isinstance(pixel_order, tuple):
--- a/examples/pioasm_pdm.py
+++ b/examples/pioasm_pdm.py
@ -4,9 +4,11 @@

 import array
 import time
+
 import board
 import digitalio
 import rp2pio
+
 import adafruit_pioasm

 trigger = digitalio.DigitalInOut(board.D4)
--- a/examples/pioasm_pulsegroup.py
+++ b/examples/pioasm_pulsegroup.py
@ -8,13 +8,12 @@

 import array

+import adafruit_ticks
 import board
 import rp2pio
-import adafruit_ticks
 import ulab.numpy as np
 from adafruit_motor import servo

-
 import adafruit_pioasm

 _cycle_count = 3
@ -73,7 +72,7 @@ class PulseItem:
    def _recalculate(self):
        self._turn_on = self._get_turn_on()
        self._turn_off = self._get_turn_off()
-        self._group._maybe_update()  # pylint: disable=protected-access
+        self._group._maybe_update()

    def _get_turn_on(self):
        maxval = self._maxval
@ -104,7 +103,7 @@ class PulseGroup:
        maxval=65535,
        stagger=False,
        auto_update=True,
-    ):  # pylint: disable=too-many-arguments
+    ):
        """Create a pulse group with the given characteristics"""
        self._frequency = round(1 / period)
        pio_frequency = round((1 + maxval) * _cycle_count / period)
@ -149,9 +148,9 @@ class PulseGroup:
        changes = {0: [0, 0]}

        for i in self._items:
-            turn_on = i._turn_on  # pylint: disable=protected-access
-            turn_off = i._turn_off  # pylint: disable=protected-access
-            mask = i._mask  # pylint: disable=protected-access
+            turn_on = i._turn_on
+            turn_off = i._turn_off
+            mask = i._mask

            if turn_on is not None:
                this_change = changes.get(turn_on)
--- a/examples/pioasm_rotaryencoder.py
+++ b/examples/pioasm_rotaryencoder.py
@ -6,8 +6,10 @@
 # https://github.com/micropython/micropython/pull/6894/files

 import array
-import rp2pio
+
 import board
+import rp2pio
+
 import adafruit_pioasm


--- a/examples/pioasm_rp2350_fifo.py
+++ b/examples/pioasm_rp2350_fifo.py
@ -16,8 +16,10 @@ The LED will blink in several patterns depending on the values loaded in the 'rx

 import array
 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm

 program = adafruit_pioasm.Program(
--- a/examples/pioasm_rxuart.py
+++ b/examples/pioasm_rxuart.py
@ -3,6 +3,7 @@
 # SPDX-License-Identifier: MIT

 import rp2pio
+
 import adafruit_pioasm

 code = adafruit_pioasm.assemble(
@ -43,8 +44,8 @@ class RXUART:
        return self.pio.frequency // 8

    @baudrate.setter
-    def baudrate(self, frequency):  # pylint: disable=unused-argument
-        self.pio.frequency = freqency * 8  # pylint: disable=undefined-variable
+    def baudrate(self, frequency):
+        self.pio.frequency = freqency * 8

    @property
    def in_waiting(self):
@ -55,5 +56,5 @@ class RXUART:
        n = self.pio.readinto(b)
        return b[:n]

-    def readinto(self, buf):  # pylint: disable=unused-argument
-        return self.pio.readinto(n)  # pylint: disable=undefined-variable
+    def readinto(self, buf):
+        return self.pio.readinto(n)
--- a/examples/pioasm_simpletest.py
+++ b/examples/pioasm_simpletest.py
@ -3,8 +3,10 @@
 # SPDX-License-Identifier: MIT

 import time
-import rp2pio
+
 import board
+import rp2pio
+
 import adafruit_pioasm

 squarewave = """
--- a/examples/pioasm_txuart.py
+++ b/examples/pioasm_txuart.py
@ -3,6 +3,7 @@
 # SPDX-License-Identifier: MIT

 import rp2pio
+
 import adafruit_pioasm

 code = adafruit_pioasm.Program(
--- a/ruff.toml
+++ b/ruff.toml
@ -0,0 +1,112 @@
+# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+target-version = "py38"
+line-length = 100
+
+[lint]
+preview = true
+select = ["I", "PL", "UP"]
+
+extend-select = [
+  "D419",  # empty-docstring
+  "E501",  # line-too-long
+  "W291",  # trailing-whitespace
+  "PLC0414",  # useless-import-alias
+  "PLC2401",  # non-ascii-name
+  "PLC2801",  # unnecessary-dunder-call
+  "PLC3002",  # unnecessary-direct-lambda-call
+  "E999",  # syntax-error
+  "PLE0101",  # return-in-init
+  "F706",  # return-outside-function
+  "F704",  # yield-outside-function
+  "PLE0116",  # continue-in-finally
+  "PLE0117",  # nonlocal-without-binding
+  "PLE0241",  # duplicate-bases
+  "PLE0302",  # unexpected-special-method-signature
+  "PLE0604",  # invalid-all-object
+  "PLE0605",  # invalid-all-format
+  "PLE0643",  # potential-index-error
+  "PLE0704",  # misplaced-bare-raise
+  "PLE1141",  # dict-iter-missing-items
+  "PLE1142",  # await-outside-async
+  "PLE1205",  # logging-too-many-args
+  "PLE1206",  # logging-too-few-args
+  "PLE1307",  # bad-string-format-type
+  "PLE1310",  # bad-str-strip-call
+  "PLE1507",  # invalid-envvar-value
+  "PLE2502",  # bidirectional-unicode
+  "PLE2510",  # invalid-character-backspace
+  "PLE2512",  # invalid-character-sub
+  "PLE2513",  # invalid-character-esc
+  "PLE2514",  # invalid-character-nul
+  "PLE2515",  # invalid-character-zero-width-space
+  "PLR0124",  # comparison-with-itself
+  "PLR0202",  # no-classmethod-decorator
+  "PLR0203",  # no-staticmethod-decorator
+  "UP004",  # useless-object-inheritance
+  "PLR0206",  # property-with-parameters
+  "PLR0904",  # too-many-public-methods
+  "PLR0911",  # too-many-return-statements
+  "PLR0912",  # too-many-branches
+  "PLR0913",  # too-many-arguments
+  "PLR0914",  # too-many-locals
+  "PLR0915",  # too-many-statements
+  "PLR0916",  # too-many-boolean-expressions
+  "PLR1702",  # too-many-nested-blocks
+  "PLR1704",  # redefined-argument-from-local
+  "PLR1711",  # useless-return
+  "C416",  # unnecessary-comprehension
+  "PLR1733",  # unnecessary-dict-index-lookup
+  "PLR1736",  # unnecessary-list-index-lookup
+
+  # ruff reports this rule is unstable
+  #"PLR6301",  # no-self-use
+
+  "PLW0108",  # unnecessary-lambda
+  "PLW0120",  # useless-else-on-loop
+  "PLW0127",  # self-assigning-variable
+  "PLW0129",  # assert-on-string-literal
+  "B033",  # duplicate-value
+  "PLW0131",  # named-expr-without-context
+  "PLW0245",  # super-without-brackets
+  "PLW0406",  # import-self
+  "PLW0602",  # global-variable-not-assigned
+  "PLW0603",  # global-statement
+  "PLW0604",  # global-at-module-level
+
+  # fails on the try: import typing used by libraries
+  #"F401",  # unused-import
+
+  "F841",  # unused-variable
+  "E722",  # bare-except
+  "PLW0711",  # binary-op-exception
+  "PLW1501",  # bad-open-mode
+  "PLW1508",  # invalid-envvar-default
+  "PLW1509",  # subprocess-popen-preexec-fn
+  "PLW2101",  # useless-with-lock
+  "PLW3301",  # nested-min-max
+]
+
+ignore = [
+    "PLR2004", # magic-value-comparison
+    "UP030", # format literals
+    "PLW1514",  # unspecified-encoding
+    "PLR0913", # too-many-arguments
+    "PLR0915", # too-many-statements
+    "PLR0917", # too-many-positional-arguments
+    "PLR0904", # too-many-public-methods
+    "PLR0912", # too-many-branches
+    "PLR0916", # too-many-boolean-expressions
+    "PLR6301", # could-be-static no-self-use
+    "PLC0415", # import outside toplevel
+    "PLC2701", # private import
+    "PLW2901", # loop var overwrite
+    "PLR1702", # too many nested blocks
+    "PLR1714", # multiple comparisons
+    "PLR0914", # too many local vars
+]
+
+[format]
+line-ending = "lf"
--- a/tests/all_pio_instructions.py
+++ b/tests/all_pio_instructions.py
@ -1,7 +1,6 @@
 # SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
-# pylint: disable=too-many-lines
 # fmt: off

 all_instruction = {
--- a/tests/test_all.py
+++ b/tests/test_all.py
@ -2,11 +2,10 @@
 #
 # SPDX-License-Identifier: MIT

+import all_pio_instructions
 import pytest
 from pytest_helpers import assert_assembles_to

-import all_pio_instructions
-

 def _assert_one(expected, instruction_in, fifo="putget"):
    program = f"""
--- a/tests/test_in.py
+++ b/tests/test_in.py
@ -58,12 +58,8 @@ def test_in_delay_with_sideset() -> None:


 def test_in_bad_source() -> None:
-    assert_assembly_fails(
-        "in bad, 17", match="Invalid in source 'bad'", errtype=ValueError
-    )
+    assert_assembly_fails("in bad, 17", match="Invalid in source 'bad'", errtype=ValueError)


 def test_in_bad_bitcount() -> None:
-    assert_assembly_fails(
-        "in pins, 0", match="Count out of range", errtype=RuntimeError
-    )
+    assert_assembly_fails("in pins, 0", match="Count out of range", errtype=RuntimeError)
--- a/tests/test_label.py
+++ b/tests/test_label.py
@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: 2024 Jeff Epler for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests out
+"""
+
+from pytest_helpers import assert_assembly_fails
+
+import adafruit_pioasm
+
+
+def test_label() -> None:
+    source = [
+        "    jmp label1",
+        "label1:",
+        "    jmp label2",
+        "public label2:",
+        "    nop",
+    ]
+    program = adafruit_pioasm.Program("\n".join(source))
+    assert program.public_labels == {"label2": 2}
+
+    # Test each combination of public/privagte label duplication
+    source = [
+        "label1:\n",
+        "nop\n",
+        "public label1:\n",
+        "nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)
+
+    source = [
+        "label1:\n",
+        "    nop\n",
+        "label1:\n",
+        "    nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)
+
+    source = [
+        "public label1:\n",
+        "    nop\n",
+        "label1:\n",
+        "    nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)
+
+    source = [
+        "public label1:\n",
+        "    nop\n",
+        "public label1:\n",
+        "    nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)
--- a/tests/test_misc.py
+++ b/tests/test_misc.py
@ -28,12 +28,8 @@ def test_invalid_sideset() -> None:


 def test_invalid_delay() -> None:
-    assert_assembly_fails(
-        "[5]", match=r"Unknown instruction: \[5\]", errtype=RuntimeError
-    )
+    assert_assembly_fails("[5]", match=r"Unknown instruction: \[5\]", errtype=RuntimeError)


 def test_invalid_instruction() -> None:
-    assert_assembly_fails(
-        "bad", match=r"Unknown instruction: bad", errtype=RuntimeError
-    )
+    assert_assembly_fails("bad", match=r"Unknown instruction: bad", errtype=RuntimeError)
--- a/tests/test_mov.py
+++ b/tests/test_mov.py
@ -11,9 +11,7 @@ from pytest_helpers import assert_assembles_to, assert_assembly_fails

 def test_mov_non_happy() -> None:
    # non happy path
-    assert_assembly_fails(
-        "mov x, blah", match="Invalid mov source 'blah'", errtype=ValueError
-    )
+    assert_assembly_fails("mov x, blah", match="Invalid mov source 'blah'", errtype=ValueError)


 def test_mov_invert() -> None:
--- a/tests/test_nop.py
+++ b/tests/test_nop.py
@ -34,9 +34,7 @@ def test_sideset_opt() -> None:

 def test_set() -> None:
    # non happy path
-    assert_assembly_fails(
-        "set isr, 1", match="Invalid set destination 'isr'", errtype=ValueError
-    )
+    assert_assembly_fails("set isr, 1", match="Invalid set destination 'isr'", errtype=ValueError)


 def test_jmp() -> None:
--- a/tests/test_out.py
+++ b/tests/test_out.py
@ -60,12 +60,8 @@ def test_out_delay_with_sideset() -> None:


 def test_out_bad_destination() -> None:
-    assert_assembly_fails(
-        "out bad, 17", match="Invalid out destination 'bad'", errtype=ValueError
-    )
+    assert_assembly_fails("out bad, 17", match="Invalid out destination 'bad'", errtype=ValueError)


 def test_out_bad_bitcount() -> None:
-    assert_assembly_fails(
-        "out pins, 0", match="Count out of range", errtype=RuntimeError
-    )
+    assert_assembly_fails("out pins, 0", match="Count out of range", errtype=RuntimeError)
--- a/tests/test_print_c_program.py
+++ b/tests/test_print_c_program.py
@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: 2025 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import contextlib
+import io
+
+import adafruit_pioasm
+
+
+def test_print_c_program():
+    output = io.StringIO()
+    with contextlib.redirect_stdout(output):
+        adafruit_pioasm.Program(".side_set 1 opt").print_c_program("mood")
+    c_program = output.getvalue()
+    assert "True" not in c_program
+    assert "sideset_enable = 1" in c_program
--- a/tests/test_pseudo.py
+++ b/tests/test_pseudo.py
@ -6,9 +6,26 @@
 Tests pseudo-ops
 """

-from pytest_helpers import assert_pio_kwargs, assert_assembly_fails
+from pytest_helpers import assert_assembly_fails, assert_pio_kwargs


 def test_offset() -> None:
    assert_pio_kwargs(".origin 7", offset=7, sideset_enable=False)
    assert_assembly_fails("nop\n.origin 7")
+
+
+def test_sideset_pindirs() -> None:
+    assert_pio_kwargs(
+        ".side_set 2 opt pindirs",
+        sideset_pin_count=2,
+        sideset_enable=True,
+        sideset_pindirs=True,
+    )
+    assert_pio_kwargs(
+        ".side_set 2 pindirs",
+        sideset_pin_count=2,
+        sideset_enable=False,
+        sideset_pindirs=True,
+    )
+    # Setting not emitted (as =False) for backwards compat
+    assert_pio_kwargs(".side_set 2", sideset_pin_count=2, sideset_enable=False)
--- a/tests/test_version.py
+++ b/tests/test_version.py
@ -6,7 +6,7 @@
 Tests version dependent instructions
 """

-from pytest_helpers import assert_pio_kwargs, assert_assembly_fails, assert_assembles_to
+from pytest_helpers import assert_assembles_to, assert_assembly_fails, assert_pio_kwargs


 def test_version() -> None:
--- a/tools/make_all.py
+++ b/tools/make_all.py
@ -6,14 +6,10 @@
 Generate test cases for adafruit_pioasm, with expected results from sdk pioasm
 """

-# pylint: disable=missing-function-docstring
-
 import re
 from subprocess import check_output

-PIOASM = (
-    "/home/jepler/src/circuitpython/ports/raspberrypi/sdk/tools/pioasm/build/pioasm"
-)
+PIOASM = "/home/jepler/src/circuitpython/ports/raspberrypi/sdk/tools/pioasm/build/pioasm"


 def assemble_one_instruction(instruction_in):
@ -31,9 +27,7 @@ def _assemble_one_instruction(instruction_in, fifo="putget"):
        {instruction_in}
        {nops}
        """
-    output = check_output(
-        [PIOASM, "/dev/stdin", "/dev/stdout"], input=program, encoding="utf-8"
-    )
+    output = check_output([PIOASM, "/dev/stdin", "/dev/stdout"], input=program, encoding="utf-8")
    return int(re.search("0x[0-9a-f]{4}", output).group(0), 16)


@ -124,7 +118,6 @@ if __name__ == "__main__":
 # SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
-# pylint: disable=too-many-lines
 # fmt: off
 """
    )
Author	SHA1	Message	Date
Scott Shawcroft	38ccee7443	Merge pull request #78 from FoamyGuy/update_frequency Use higher frequency values	2025-07-25 13:26:07 -07:00
foamyguy	ba88388ce3	Use higher frequency values	2025-07-25 10:54:49 -05:00
foamyguy	47bb463da0	update rtd.yml file Signed-off-by: foamyguy <foamyguy@gmail.com>	2025-06-17 10:31:22 -05:00
foamyguy	52ba2fa0ec	Merge pull request #77 from adafruit/use_ruff change to ruff	2025-05-16 13:40:01 -05:00
foamyguy	1539f0a96e	change to ruff	2025-05-16 18:31:52 +00:00
Jeff Epler	f78d675d42	Merge pull request #76 from adafruit/fix-print-c-program Avoid printing `True` in C program	2025-01-23 16:41:06 -06:00
Jeff Epler	649526118b	Avoid printing `True` in C program & test it! Closes: #74	2025-01-23 16:13:12 -06:00
foamyguy	00cb534d03	add sphinx configuration to rtd.yaml Signed-off-by: foamyguy <foamyguy@gmail.com>	2025-01-16 09:17:23 -06:00
Scott Shawcroft	0482020265	Merge pull request #73 from adafruit/side-set-pindirs-directive Add support for `.side_set ... pindirs`	2024-12-03 10:16:09 -08:00
Jeff Epler	23bd1b13e7	Add support for `.side_set ... pindirs` This also requires a core change to set the respective bit in the PIO hardware.	2024-12-01 11:11:09 -06:00
foamyguy	de37174dbc	remove deprecated get_html_theme_path() call Signed-off-by: foamyguy <foamyguy@gmail.com>	2024-10-07 14:48:47 -05:00
Jeff Epler	11ddcb5327	Merge pull request #72 from adafruit/public-labels-etc Add public_labels, test of labels	2024-09-24 16:58:45 -05:00
Jeff Epler	d6dcfab478	Update adafruit_pioasm.py Co-authored-by: Scott Shawcroft <scott@adafruit.com>	2024-09-24 16:58:29 -05:00
Jeff Epler	b746aec729	Add public_labels, test of labels Now, a label declared with `public foo:` will be exported in the `public_labels` property of `Program` objects. Additionally, a test of this feature as well as the existing duplicate label detection feature is added. Change the return type of `assemble` so that it better reflects reality Add docstrings for the public properties of Program objects	2024-09-19 22:13:14 -05:00