vector 1.4.0__tar.gz → 1.4.1__tar.gz

{vector-1.4.0 → vector-1.4.1}/.github/workflows/cd.yml

@@ -9,6 +9,10 @@ on:
 jobs:
   dist:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
     steps:
       - uses: actions/checkout@v4
         with:
@@ -17,13 +21,18 @@ jobs:
       - name: Build SDist and wheel
         run: pipx run build
 
+      - name: Check metadata
+        run: pipx run twine check dist/*
+
+      - name: Generate artifact attestation for sdist and wheel
+        uses: actions/attest-build-provenance@49df96e17e918a15956db358890b08e61c704919 # v1.2.0
+        with:
+          subject-path: "dist/vector-*"
+
       - uses: actions/upload-artifact@v4
         with:
           path: dist/*
 
-      - name: Check metadata
-        run: pipx run twine check dist/*
-
   publish:
     needs: [dist]
     runs-on: ubuntu-latest
@@ -40,4 +49,17 @@ jobs:
           name: artifact
           path: dist
 
+      - name: List distributions to be deployed
+        run: ls -l dist/
+
+      - name: Verify sdist artifact attestation
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh attestation verify dist/vector-*.tar.gz --repo ${{ github.repository }}
+
+      - name: Verify wheel artifact attestation
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh attestation verify dist/vector-*.whl --repo ${{ github.repository }}
+
       - uses: pypa/gh-action-pypi-publish@release/v1

{vector-1.4.0 → vector-1.4.1}/.github/workflows/ci.yml

@@ -146,7 +146,7 @@ jobs:
         run: python -m pytest -ra --cov=vector --ignore tests/test_notebooks.py .
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v4.3.0
+        uses: codecov/codecov-action@v4.4.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 

{vector-1.4.0 → vector-1.4.1}/.pre-commit-config.yaml

@@ -19,19 +19,14 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.4.1"
+    rev: "v0.4.4"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 
-  - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "1.8.0"
-    hooks:
-      - id: pyproject-fmt
-
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.9.0
+    rev: v1.10.0
     hooks:
       - id: mypy
         files: src

{vector-1.4.0 → vector-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: vector
-Version: 1.4.0
+Version: 1.4.1
 Summary: Vector classes and utilities
 Project-URL: Bug Tracker, https://github.com/scikit-hep/vector/issues
 Project-URL: Changelog, https://vector.readthedocs.io/en/latest/changelog.html
@@ -831,6 +831,104 @@ def compute_masses(array):
 compute_masses(array)
 ```
 
+## Sub-classing Awkward mixins
+
+At the moment, it is possible to sub-class vector awkward mixins to extend the vector functionalities. Although the mechanism in place works well, it is still being improved.
+
+For instance, the `MomentumAwkward` classes can be extended in the following way:
+
+```py
+@ak.mixin_class(vector.backends.awkward.behavior)
+class TwoVector(vector.backends.awkward.MomentumAwkward2D):
+    pass
+
+
+@ak.mixin_class(vector.backends.awkward.behavior)
+class ThreeVector(vector.backends.awkward.MomentumAwkward3D):
+    pass
+
+
+# required for transforming vectors
+# the class names must always end with "Array"
+TwoVectorArray.ProjectionClass2D = TwoVectorArray  # noqa: F821
+TwoVectorArray.ProjectionClass3D = ThreeVectorArray  # noqa: F821
+TwoVectorArray.MomentumClass = TwoVectorArray  # noqa: F821
+
+ThreeVectorArray.ProjectionClass2D = TwoVectorArray  # noqa: F821
+ThreeVectorArray.ProjectionClass3D = ThreeVectorArray  # noqa: F821
+ThreeVectorArray.MomentumClass = ThreeVectorArray  # noqa: F821
+
+vec = ak.zip(
+    {
+        "pt": [[1, 2], [], [3], [4]],
+        "phi": [[1.2, 1.4], [], [1.6], [3.4]],
+    },
+    with_name="TwoVector",
+    behavior=vector.backends.awkward.behavior,
+)
+
+vec
+```
+
+The binary operators are not automatically registered by awkward, but vector methods can be used to perform operations on sub-classed vectors.
+
+```py
+vec.add(vec)
+```
+
+Similarly, other vector methods can be used by the new methods internally.
+
+```py
+@ak.mixin_class(vector.backends.awkward.behavior)
+class LorentzVector(vector.backends.awkward.MomentumAwkward4D):
+    @ak.mixin_class_method(np.divide, {numbers.Number})
+    def divide(self, factor):
+        return self.scale(1 / factor)
+
+
+# required for transforming vectors
+# the class names must always end with "Array"
+LorentzVectorArray.ProjectionClass2D = TwoVectorArray  # noqa: F821
+LorentzVectorArray.ProjectionClass3D = ThreeVectorArray  # noqa: F821
+LorentzVectorArray.ProjectionClass4D = LorentzVectorArray  # noqa: F821
+LorentzVectorArray.MomentumClass = LorentzVectorArray  # noqa: F821
+
+vec = ak.zip(
+    {
+        "pt": [[1, 2], [], [3], [4]],
+        "eta": [[1.2, 1.4], [], [1.6], [3.4]],
+        "phi": [[0.3, 0.4], [], [0.5], [0.6]],
+        "energy": [[50, 51], [], [52], [60]],
+    },
+    with_name="LorentzVector",
+    behavior=vector.backends.awkward.behavior,
+)
+
+vec / 2
+vec.like(vector.obj(x=1, y=2))
+vec.like(vector.obj(x=1, y=2, z=3))
+```
+
+It is also possible to manually add binary operations in vector's behavior dict to enable binary operations.
+
+```py
+_binary_dispatch_cls = {
+    "TwoVector": TwoVector,
+    "ThreeVector": ThreeVector,
+    "LorentzVector": LorentzVector,
+}
+_rank = [TwoVector, ThreeVector, LorentzVector]
+
+for lhs, lhs_to in _binary_dispatch_cls.items():
+    for rhs, rhs_to in _binary_dispatch_cls.items():
+        out_to = min(lhs_to, rhs_to, key=_rank.index)
+        vector.backends.awkward.behavior[(np.add, lhs, rhs)] = out_to.add
+        vector.backends.awkward.behavior[(np.subtract, lhs, rhs)] = out_to.subtract
+
+vec + vec
+vec.to_2D() + vec.to_2D()
+```
+
 ## Talks about vector
 
 - 9th October 2023 - [What’s new with Vector? First major release is out!](https://indi.to/35ym5) - [PyHEP 2023 (virtual)](https://indico.cern.ch/event/1252095/) [🎥](https://www.youtube.com/watch?v=JHEAb2R3xzE&list=PLKZ9c4ONm-VlAorAG8kR09ZqhMfHiH2LJ&index=10)

{vector-1.4.0 → vector-1.4.1}/README.md

@@ -761,6 +761,104 @@ def compute_masses(array):
 compute_masses(array)
 ```
 
+## Sub-classing Awkward mixins
+
+At the moment, it is possible to sub-class vector awkward mixins to extend the vector functionalities. Although the mechanism in place works well, it is still being improved.
+
+For instance, the `MomentumAwkward` classes can be extended in the following way:
+
+```py
+@ak.mixin_class(vector.backends.awkward.behavior)
+class TwoVector(vector.backends.awkward.MomentumAwkward2D):
+    pass
+
+
+@ak.mixin_class(vector.backends.awkward.behavior)
+class ThreeVector(vector.backends.awkward.MomentumAwkward3D):
+    pass
+
+
+# required for transforming vectors
+# the class names must always end with "Array"
+TwoVectorArray.ProjectionClass2D = TwoVectorArray  # noqa: F821
+TwoVectorArray.ProjectionClass3D = ThreeVectorArray  # noqa: F821
+TwoVectorArray.MomentumClass = TwoVectorArray  # noqa: F821
+
+ThreeVectorArray.ProjectionClass2D = TwoVectorArray  # noqa: F821
+ThreeVectorArray.ProjectionClass3D = ThreeVectorArray  # noqa: F821
+ThreeVectorArray.MomentumClass = ThreeVectorArray  # noqa: F821
+
+vec = ak.zip(
+    {
+        "pt": [[1, 2], [], [3], [4]],
+        "phi": [[1.2, 1.4], [], [1.6], [3.4]],
+    },
+    with_name="TwoVector",
+    behavior=vector.backends.awkward.behavior,
+)
+
+vec
+```
+
+The binary operators are not automatically registered by awkward, but vector methods can be used to perform operations on sub-classed vectors.
+
+```py
+vec.add(vec)
+```
+
+Similarly, other vector methods can be used by the new methods internally.
+
+```py
+@ak.mixin_class(vector.backends.awkward.behavior)
+class LorentzVector(vector.backends.awkward.MomentumAwkward4D):
+    @ak.mixin_class_method(np.divide, {numbers.Number})
+    def divide(self, factor):
+        return self.scale(1 / factor)
+
+
+# required for transforming vectors
+# the class names must always end with "Array"
+LorentzVectorArray.ProjectionClass2D = TwoVectorArray  # noqa: F821
+LorentzVectorArray.ProjectionClass3D = ThreeVectorArray  # noqa: F821
+LorentzVectorArray.ProjectionClass4D = LorentzVectorArray  # noqa: F821
+LorentzVectorArray.MomentumClass = LorentzVectorArray  # noqa: F821
+
+vec = ak.zip(
+    {
+        "pt": [[1, 2], [], [3], [4]],
+        "eta": [[1.2, 1.4], [], [1.6], [3.4]],
+        "phi": [[0.3, 0.4], [], [0.5], [0.6]],
+        "energy": [[50, 51], [], [52], [60]],
+    },
+    with_name="LorentzVector",
+    behavior=vector.backends.awkward.behavior,
+)
+
+vec / 2
+vec.like(vector.obj(x=1, y=2))
+vec.like(vector.obj(x=1, y=2, z=3))
+```
+
+It is also possible to manually add binary operations in vector's behavior dict to enable binary operations.
+
+```py
+_binary_dispatch_cls = {
+    "TwoVector": TwoVector,
+    "ThreeVector": ThreeVector,
+    "LorentzVector": LorentzVector,
+}
+_rank = [TwoVector, ThreeVector, LorentzVector]
+
+for lhs, lhs_to in _binary_dispatch_cls.items():
+    for rhs, rhs_to in _binary_dispatch_cls.items():
+        out_to = min(lhs_to, rhs_to, key=_rank.index)
+        vector.backends.awkward.behavior[(np.add, lhs, rhs)] = out_to.add
+        vector.backends.awkward.behavior[(np.subtract, lhs, rhs)] = out_to.subtract
+
+vec + vec
+vec.to_2D() + vec.to_2D()
+```
+
 ## Talks about vector
 
 - 9th October 2023 - [What’s new with Vector? First major release is out!](https://indi.to/35ym5) - [PyHEP 2023 (virtual)](https://indico.cern.ch/event/1252095/) [🎥](https://www.youtube.com/watch?v=JHEAb2R3xzE&list=PLKZ9c4ONm-VlAorAG8kR09ZqhMfHiH2LJ&index=10)

{vector-1.4.0 → vector-1.4.1}/docs/changelog.md

@@ -2,6 +2,31 @@
 
 ## Version 1.4
 
+### Version 1.4.1
+
+#### Fixes
+
+- fix: sympy backend on numpy 2.0 (full numpy 2.0 support) [#473][]
+- fix: add lower and upper bounds for deltaangle [#465][]
+- fix: maximum for SymPy backend is the identity function now [#465][]
+- fix: get coordinate classes to work for numpy [#466][]
+
+#### Documentation
+
+- docs: add basic docs for sub-classing awkward mixins [#468][]
+
+#### Maintenance
+
+- chore: add missing compute function tests [#454]
+- ci: Add GitHub artifact attestations to package distribution [#470][]
+
+[#473]: https://github.com/scikit-hep/vector/pull/473
+[#465]: https://github.com/scikit-hep/vector/pull/465
+[#466]: https://github.com/scikit-hep/vector/pull/466
+[#468]: https://github.com/scikit-hep/vector/pull/468
+[#454]: https://github.com/scikit-hep/vector/pull/454
+[#470]: https://github.com/scikit-hep/vector/pull/470
+
 ### Version 1.4.0
 
 #### Features