c65of 1.0.0__tar.gz

c65of-1.0.0/.github/dependabot.yml

@@ -0,0 +1,17 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

c65of-1.0.0/.github/workflows/release-python.yml

@@ -0,0 +1,45 @@
+---
+name: Build python packages for release
+
+# pbr derives the version from the git tag, so a release is a tag push.
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+env:
+  RELEASE_PY_VER: "3.13"
+
+jobs:
+  python-package:
+    name: "Build and publish python packages"
+    runs-on: ubuntu-latest
+    environment:
+      name: "release"
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v7
+        with:
+          # Full history and tags: pbr reads the version from git describe.
+          fetch-depth: 0
+      - name: Set up python-${{ env.RELEASE_PY_VER }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.RELEASE_PY_VER }}
+      - name: Build sdist and wheel
+        run: |
+          pip install -U build
+          python3 -m build
+      - name: Check the built version matches the tag
+        run: |
+          tag="${GITHUB_REF_NAME}"
+          if [ ! -f "dist/c65of-${tag}.tar.gz" ]; then
+            echo "tag ${tag} did not produce dist/c65of-${tag}.tar.gz:"
+            ls -1 dist
+            exit 1
+          fi
+      - name: Publish python package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

c65of-1.0.0/.github/workflows/tests-codecheck.yml

@@ -0,0 +1,28 @@
+---
+name: Code checks
+
+on: [push, pull_request]
+
+jobs:
+  codecheck:
+    name: Code checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v7
+      - name: Set up python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: |
+          pip3 install -r codecheck-requirements.txt
+          pip3 install --no-deps -e .
+      - name: black
+        run: black --check --diff c65of tests
+      - name: pylint
+        run: pylint c65of tests
+      - name: flake8
+        run: flake8 --max-line-length=100 --extend-ignore=E203,W503 c65of tests
+      - name: pyright
+        run: pyright

c65of-1.0.0/.github/workflows/tests-unit.yml

@@ -0,0 +1,31 @@
+---
+name: Unit tests
+
+on: [push, pull_request]
+
+jobs:
+  unit-tests:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v7
+      - name: Set up python-${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip3 install -r test-requirements.txt
+          pip3 install --no-deps -e .
+      - name: Run unit tests
+        run: |
+          pytest -n auto --cov=c65of --cov-report=xml \
+            --cov-fail-under=90 tests
+      - if: ${{ matrix.python-version == '3.13' }}
+        name: Upload codecov
+        uses: codecov/codecov-action@v7

c65of-1.0.0/.pylintrc

@@ -0,0 +1,24 @@
+[MAIN]
+jobs=0
+
+[MESSAGES CONTROL]
+# Protocol structs are wide by nature: field counts and constant tables are
+# dictated by the wire format, not by our design.
+disable=
+    duplicate-code,
+    too-few-public-methods,
+    too-many-arguments,
+    too-many-instance-attributes,
+    too-many-locals,
+    too-many-positional-arguments,
+# %-formatting is the house style shared with faucet.
+    consider-using-f-string,
+# Constructors are compiled by c65of.codec from the declared wire layout, so
+# pylint cannot see where an attribute is first assigned. The declared
+# attributes are published on the class with their defaults instead.
+    attribute-defined-outside-init,
+    access-member-before-definition,
+    no-member,
+
+[FORMAT]
+max-line-length=100

c65of-1.0.0/AUTHORS

@@ -0,0 +1,2 @@
+Josh Bailey <anarkiwi@users.noreply.github.com>
+Josh Bailey <josh@overlyspecific.com>

c65of-1.0.0/ChangeLog

@@ -0,0 +1,26 @@
+CHANGES
+=======
+
+1.0.0
+-----
+
+* controller: name the datapath before publishing its features reply
+* multipart: say so when a single-body stats reply arrives empty
+* addrconv: accept an ipaddress object, as netaddr did
+* OpenFlow channel and datapath registry
+* Nicira conntrack actions and the NXM match fields
+* ci: publish to PyPI via Trusted Publishing on a version tag
+* Guard that the runtime import graph is stdlib only
+* Add hub.StreamServer; record the migration gaps
+* Declare parser.\_\_all\_\_ so the re-exports are explicit
+* Multipart family; make parser one module again
+* OF1.3 messages; fix three bugs the coverage gate exposed
+* OF event classes, generated from the message registry
+* Packet layer: IPv6, ICMPv6, LLDP, LACP, BPDU constants
+* Config value conversion helpers
+* Land cls\_from\_jsondict\_key; test that a shared class name resolves
+* Application framework and threading helpers
+* Add OFPPort; resolve nested class names by enclosing module
+* OF1.3 match, actions and instructions; ethernet and VLAN
+* Scaffold c65of: declarative codec, address lib, OF1.3 constants, OXM
+* Initial commit

c65of-1.0.0/Dockerfile.tests

@@ -0,0 +1,10 @@
+# Multistage so dependency layers survive source-only changes.
+FROM python:3.13-slim AS deps
+WORKDIR /c65of-src
+COPY requirements.txt test-requirements.txt codecheck-requirements.txt ./
+RUN pip3 install --no-cache-dir -r codecheck-requirements.txt
+
+FROM deps AS test
+COPY ./ /c65of-src/
+RUN pip3 install --no-cache-dir --no-deps -e .
+CMD ["./run_tests.sh"]

c65of-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

c65of-1.0.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: c65of
+Version: 1.0.0
+Summary: OpenFlow 1.3 protocol, packet and controller library with no runtime dependencies
+Home-page: https://github.com/c65sdn/c65of
+Author: c65sdn
+License: Apache-2
+Keywords: openflow,openvswitch,sdn
+Platform: any
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: System :: Networking
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: Unix
+Requires-Python: >=3.12
+License-File: LICENSE
+Requires-Dist: pbr>=7.0.3
+Dynamic: author
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

c65of-1.0.0/README.rst

@@ -0,0 +1,59 @@
+=====
+c65of
+=====
+
+OpenFlow 1.3 protocol, packet parsing and controller library for python, with
+no runtime dependencies.
+
+c65of replaces `os-ken <https://opendev.org/openstack/os-ken>`_ for
+`c65faucet <https://github.com/c65sdn/faucet>`_. It covers the OpenFlow 1.3
+wire protocol, the ethernet/IP packet formats an OpenFlow controller needs to
+parse, and the controller channel and application framework -- and nothing
+else, so it does not shed surface underneath its consumers.
+
+Install
+=======
+
+.. code:: bash
+
+    pip3 install c65of
+
+Use
+===
+
+.. code:: python
+
+    from c65of import ofproto as ofp
+    from c65of.ofproto import parser
+
+    match = parser.OFPMatch(eth_type=0x800, ipv4_dst="10.0.0.0/8")
+    mod = parser.OFPFlowMod(datapath, table_id=1, priority=100, match=match)
+
+Design
+======
+
+Wire formats are declared, not hand written: a class states its struct layout
+and the codec compiles the constructor, the packer and the JSON dict form. See
+`docs/design.rst <docs/design.rst>`_.
+
+Encoding is verified against os-ken byte for byte by the differential test
+suite; os-ken is a test dependency only.
+
+Development
+===========
+
+.. code:: bash
+
+    pip3 install -r codecheck-requirements.txt
+    ./run_tests.sh
+
+Or in docker:
+
+.. code:: bash
+
+    docker build -f Dockerfile.tests -t c65of-tests . && docker run c65of-tests
+
+Licence
+=======
+
+Apache 2.0. Portions are ported from os-ken, also Apache 2.0.

c65of-1.0.0/c65of/__init__.py

@@ -0,0 +1 @@
+"""OpenFlow 1.3 protocol, packet and controller library."""