pyiges 0.3.2__tar.gz → 0.3.4__tar.gz

{pyiges-0.3.2 → pyiges-0.3.4}/.github/workflows/testing-and-deployment.yml

@@ -44,15 +44,33 @@ jobs:
         flit build
         twine check dist/*
 
-    - name: Upload to PyPi
-      if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+  pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    needs: [unit_tests]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyiges
+    permissions:
+      id-token: write # this permission is mandatory for trusted publishing
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+
+    - name: Build package
       run: |
-        pip install twine
-        twine upload --skip-existing dist/pyiges*
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.TWINE_TOKEN }}
-        TWINE_REPOSITORY_URL: https://upload.pypi.org/legacy/
+        pip install flit
+        flit build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
 
   Release:
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')

{pyiges-0.3.2 → pyiges-0.3.4}/.pre-commit-config.yaml

@@ -5,7 +5,7 @@ ci:
 
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.11.12
+  rev: v0.15.9
   hooks:
   - id: ruff-check
     args: [--fix, --exit-non-zero-on-fix]
@@ -13,13 +13,13 @@ repos:
   - id: ruff-format
 
 - repo: https://github.com/keewis/blackdoc
-  rev: v0.3.9
+  rev: v0.4.6
   hooks:
   - id: blackdoc
     exclude: README.rst
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.4.1
+  rev: v2.4.2
   hooks:
   - id: codespell
     args: [--skip=*.vt*]
@@ -29,23 +29,23 @@ repos:
   hooks:
   - id: pydocstyle
     additional_dependencies: [tomli==2.0.1]
-    files: ^src/pyminiply/.*\.py
+    files: ^src/pyiges/.*\.py
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.16.0
+  rev: v1.20.0
   hooks:
   - id: mypy
     additional_dependencies: [numpy>=2.0, pytest-stub]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v5.0.0
+  rev: v6.0.0
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
   - id: trailing-whitespace
 
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.14.0
+  rev: v2.16.0
   hooks:
   - id: pretty-format-toml
     args: [--autofix]
@@ -53,11 +53,11 @@ repos:
     args: [--autofix, --indent, '2']
 
 - repo: https://github.com/pre-commit/mirrors-clang-format
-  rev: v20.1.5
+  rev: v22.1.2
   hooks:
   - id: clang-format
 
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.33.0
+  rev: 0.37.1
   hooks:
   - id: check-github-workflows

{pyiges-0.3.2 → pyiges-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyiges
-Version: 0.3.2
+Version: 0.3.4
 Summary: Pythonic IGES reader
 Keywords: iges,cad,nurbs,bspline
 Author-email: PyVista Developers <info@pyvista.org>

{pyiges-0.3.2 → pyiges-0.3.4}/pyproject.toml

@@ -30,7 +30,12 @@ license = {text = "MIT"}
 name = "pyiges"
 readme = "README.rst"
 requires-python = ">=3.9"
-version = "0.3.2"
+version = "0.3.4"
+
+# Requires pyvista >= 0.48
+[project.entry-points."pyvista.readers"]
+".iges" = "pyiges:read_as_mesh"
+".igs" = "pyiges:read_as_mesh"
 
 [project.optional-dependencies]
 docs = [

{pyiges-0.3.2 → pyiges-0.3.4}/src/pyiges/__init__.py

@@ -3,10 +3,11 @@
 from importlib.metadata import PackageNotFoundError, version
 
 from pyiges.iges import Iges, read
+from pyiges.reader import read_as_mesh
 
 try:
-    __version__ = version("pyminiply")
+    __version__ = version("pyiges")
 except PackageNotFoundError:
     __version__ = "unknown"
 
-__all__ = ["read", "Iges", "__version__"]
+__all__ = ["read", "read_as_mesh", "Iges", "__version__"]

{pyiges-0.3.2 → pyiges-0.3.4}/src/pyiges/check_imports.py

@@ -1,3 +1,5 @@
+"""Optional-dependency probes for the ``[full]`` install variant."""
+
 try:
     import geomdl
     import pyvista
@@ -17,6 +19,13 @@ except (ModuleNotFoundError, ImportError) as exc:
 
 
 def assert_full_module_variant(inner_func):
+    """Wrap a function to require the optional ``[full]`` install variant.
+
+    Raises an exception at call time if any of ``pyvista``, ``geomdl``,
+    or VTK could not be imported, instructing the user to install
+    ``pyiges[full]``.
+    """
+
     def safe_func(*a, **kw):
         if not _IS_FULL_MODULE:
             raise Exception(_PROBLEM_MSG)

{pyiges-0.3.2 → pyiges-0.3.4}/src/pyiges/constants.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+"""IGES protocol constants."""
 
 line_font_pattern = {
     None: "Default",

{pyiges-0.3.2 → pyiges-0.3.4}/src/pyiges/entity.py

@@ -6,7 +6,7 @@ from pyiges.constants import line_font_pattern
 
 
 class Entity:
-    """Generic IGES entity
+    """Generic IGES entity.
 
     Examples
     --------
@@ -35,11 +35,18 @@ class Entity:
     """
 
     def __init__(self, iges):
+        """Initialize an empty entity bound to its parent ``Iges`` reader."""
         self.d = dict()
         self.parameters = []
         self.iges = iges
 
     def add_section(self, string, key, type="int"):
+        """Parse one fixed-width directory-section field and store it under ``key``.
+
+        Handles the special-case ``status_number`` field, which is four
+        space-padded 2-digit values that must be normalised before
+        casting to ``int``.
+        """
         string = string.strip()
         if type == "string":
             self.d[key] = string
@@ -63,6 +70,7 @@ class Entity:
                 self.d[key] = None
 
     def __str__(self):
+        """Return the multi-line directory-section dump used by ``print``."""
         s = "----- Entity -----" + os.linesep
         s += str(self.d["entity_type_number"]) + os.linesep
         s += str(self.d["parameter_pointer"]) + os.linesep

{pyiges-0.3.2 → pyiges-0.3.4}/src/pyiges/examples/__init__.py

@@ -1,3 +1,5 @@
+"""Bundled example IGES files for documentation and tests."""
+
 import os
 
 filepath = os.path.dirname(__file__)

{pyiges-0.3.2 → pyiges-0.3.4}/src/pyiges/geometry.py

@@ -1,3 +1,5 @@
+"""IGES entity classes for points, curves, surfaces, and B-Rep elements."""
+
 import os
 
 import numpy as np
@@ -8,10 +10,11 @@ from pyiges.entity import Entity
 
 
 def parse_float(str_value):
-    """
-    This function converts a string to float just like the built-in
-    float() function. In addition to "normal" numbers it also handles
-    numbers such as 1.2D3 (equivalent to 1.2E3).
+    """Convert a string to ``float``, accepting Fortran ``D`` exponents.
+
+    In addition to "normal" numbers it also handles values such as
+    ``1.2D3`` (equivalent to ``1.2E3``) that appear in IGES files
+    written by Fortran-era CAD systems.
     """
     try:
         return float(str_value)
@@ -20,7 +23,7 @@ def parse_float(str_value):
 
 
 class Point(Entity):
-    """IGES Point"""
+    """IGES Point."""
 
     def _add_parameters(self, parameters):
         self._x = parse_float(parameters[1])
@@ -29,35 +32,37 @@ class Point(Entity):
 
     @property
     def x(self):
-        """X coordinate"""
+        """X coordinate."""
         return self._x
 
     @property
     def y(self):
-        """Y coordinate"""
+        """Y coordinate."""
         return self._y
 
     @property
     def z(self):
-        """Z coordinate"""
+        """Z coordinate."""
         return self._z
 
     @property
     def coordinate(self):
-        """Coordinate of the point as a numpy array"""
+        """Coordinate of the point as a numpy array."""
         return np.array([self._x, self._y, self._z])
 
     def __repr__(self):
+        """Return a multi-line string with the point coordinates."""
         s = "--- IGES Point ---" + os.linesep
         s += f"{self._x}, {self._y}, {self._z} {os.linesep}"
         return s
 
     def __str__(self):
+        """Return the same multi-line representation as ``__repr__``."""
         return self.__repr__()
 
     @assert_full_module_variant
     def to_vtk(self):
-        """Point represented as a ``pyvista.PolyData`` Mesh
+        """Return the point as a ``pyvista.PolyData`` mesh.
 
         Returns
         -------
@@ -68,7 +73,7 @@ class Point(Entity):
 
 
 class Line(Entity):
-    """IGES Straight line segment"""
+    """IGES straight line segment."""
 
     def _add_parameters(self, parameters):
         self._x1 = parse_float(parameters[1])
@@ -80,10 +85,11 @@ class Line(Entity):
 
     @property
     def coordinates(self):
-        """Starting and ending point of the line as a ``numpy`` array"""
+        """Starting and ending point of the line as a ``numpy`` array."""
         return np.array([[self._x1, self._y1, self._z1], [self._x2, self._y2, self._z2]])
 
     def __repr__(self):
+        """Return a multi-line string with the line endpoints."""
         s = "--- IGES Line ---" + os.linesep
         s += Entity.__str__(self) + os.linesep
         s += f"From point {self._x1}, {self._y1}, {self._z1} {os.linesep}"
@@ -92,19 +98,25 @@ class Line(Entity):
 
     @assert_full_module_variant
     def to_vtk(self, resolution=1):
-        """Line represented as a ``pyvista.PolyData`` Mesh
+        """Return the line as a ``pyvista.PolyData`` mesh.
 
         Returns
         -------
         mesh : ``pyvista.PolyData``
             ``pyvista`` mesh
         """
-        return pv.Line([self._x1, self._y1, self._z1], [self._x2, self._y2, self._z2], resolution)
+        return pv.Line(
+            [self._x1, self._y1, self._z1],
+            [self._x2, self._y2, self._z2],
+            resolution=resolution,
+        )
 
 
 class Transformation(Entity):
-    """Transforms entities by matrix multiplication and vector
-    addition to give a translation, as shown below:
+    """IGES Type 124 transformation matrix.
+
+    Transforms entities by matrix multiplication and vector addition
+    to give a translation, as shown below.
 
     Notes
     -----
@@ -117,7 +129,8 @@ class Transformation(Entity):
     """
 
     def _add_parameters(self, parameters):
-        """
+        """Parse the twelve REAL coefficients of the 3x4 transform matrix.
+
         Index in list	Type of data	Name	Description
         1	REAL	R11	First row
         2	REAL	R12	..
@@ -142,12 +155,13 @@ class Transformation(Entity):
         self.t3 = parse_float(parameters[12])
 
     def __repr__(self):
+        """Return a multi-line string with the affine matrix."""
         txt = "IGES 124 Transformation Matrix\n"
         txt += str(self.to_affine())
         return txt
 
     def to_affine(self):
-        """Return a 4x4 affline transformation matrix"""
+        """Return a 4x4 affine transformation matrix."""
         return np.array(
             [
                 [self.r11, self.r12, self.r13, self.t1],
@@ -159,7 +173,7 @@ class Transformation(Entity):
 
     @assert_full_module_variant
     def _to_vtk(self):
-        """Convert to a vtk transformation matrix"""
+        """Convert to a vtk transformation matrix."""
         vtkmatrix = pv.vtkmatrix_from_array(self.to_affine())
         import vtk
 
@@ -169,13 +183,12 @@ class Transformation(Entity):
 
 
 class ConicArc(Entity):
-    """Conic Arc (Type 104)
-    Arc defined by the equation:
-    ``A*x**2 + B*x*y + C*y**2 + D*x + E*y + F = 0``
-
-    with a Transformation Matrix (Entity 124). Can define
-    an ellipse, parabola, or hyperbola.
+    """IGES Type 104 conic arc.
 
+    Arc defined by the equation
+    ``A*x**2 + B*x*y + C*y**2 + D*x + E*y + F = 0``
+    with a Transformation Matrix (Entity 124). Can define an ellipse,
+    parabola, or hyperbola.
     """
 
     # The definitions of the terms ellipse, parabola, and hyperbola
@@ -192,7 +205,8 @@ class ConicArc(Entity):
     # A parabola if Q2 = 0 and Q1 != 0.
 
     def _add_parameters(self, parameters):
-        """
+        """Parse the six conic coefficients and two endpoints.
+
         Index	Type	Name	Description
         1	REAL	A	coefficient of xt^2
         2	REAL	B	coefficient of xtyt
@@ -221,6 +235,7 @@ class ConicArc(Entity):
         self.z2 = parameters[12]  #  z coordinate of end point
 
     def __repr__(self):
+        """Return a multi-line string with the conic coefficients."""
         info = "Conic Arc\nIGES Type 104\n"
         info += f"Start:  ({self.x1:f}, {self.y1:f}, {self.z1:f})\n"
         info += f"End:    ({self.x2:f}, {self.y2:f}, {self.z2:f})\n"
@@ -234,6 +249,7 @@ class ConicArc(Entity):
 
     @assert_full_module_variant
     def to_vtk(self):
+        """Tessellate the conic arc as a ``pyvista.PolyData`` (not yet implemented)."""
         # a*x**2 + b*x*y + c*y**2 + d*x + e*y + f = 0
         # from sympy import Symbol
         # from sympy.solvers import Solve
@@ -254,9 +270,9 @@ class ConicArc(Entity):
 
 
 class RationalBSplineCurve(Entity):
-    """Rational B-Spline Curve
-    IGES Spec v5.3 p. 123 Section 4.23
-    See also Appendix B, p. 545
+    """Rational B-Spline curve.
+
+    See IGES Spec v5.3 p. 123 Section 4.23, and Appendix B p. 545.
     """
 
     def _add_parameters(self, parameters):
@@ -304,6 +320,7 @@ class RationalBSplineCurve(Entity):
             self.planar_curve = False
 
     def __str__(self):
+        """Return a multi-line string with knots, weights, and control points."""
         s = "--- Rational B-Spline Curve ---" + os.linesep
         s += Entity.__str__(self) + os.linesep
         s += str(self.T) + os.linesep
@@ -316,6 +333,7 @@ class RationalBSplineCurve(Entity):
 
     @assert_full_module_variant
     def to_geomdl(self):
+        """Return a ``geomdl.NURBS.Curve`` built from this entity's parameters."""
         from geomdl import NURBS
 
         curve = NURBS.Curve()
@@ -327,7 +345,14 @@ class RationalBSplineCurve(Entity):
 
     @assert_full_module_variant
     def to_vtk(self, delta=0.01):
-        """Set evaluation delta (controls the number of curve points)"""
+        """Tessellate the curve as a ``pyvista.PolyData`` polyline.
+
+        Parameters
+        ----------
+        delta : float, optional
+            Evaluation delta passed to ``geomdl``. Smaller values give
+            denser tessellations at the cost of compute time.
+        """
         # Create a 3-dimensional B-spline Curve
         curve = self.to_geomdl()
         curve.delta = delta
@@ -345,8 +370,7 @@ class RationalBSplineCurve(Entity):
 
 
 class RationalBSplineSurface(Entity):
-    """Rational B-Spline Surface
-
+    """Rational B-Spline surface.
 
     Examples
     --------
@@ -395,37 +419,37 @@ class RationalBSplineSurface(Entity):
 
     @property
     def k1(self):
-        """Upper index of first sum"""
+        """Upper index of first sum."""
         return self._k1
 
     @property
     def k2(self):
-        """Upper index of second sum"""
+        """Upper index of second sum."""
         return self._k2
 
     @property
     def m1(self):
-        """Degree of first basis functions"""
+        """Degree of first basis functions."""
         return self._m1
 
     @property
     def m2(self):
-        """Degree of second basis functions"""
+        """Degree of second basis functions."""
         return self._m2
 
     @property
     def flag1(self):
-        """Closed in the first direction"""
+        """Closed in the first direction."""
         return self._flag1
 
     @property
     def flag2(self):
-        """Closed in the second direction"""
+        """Closed in the second direction."""
         return self._flag2
 
     @property
     def flag3(self):
-        """Polynominal
+        """Polynomial flag.
 
         ``False`` - rational
         ``True``  - polynomial
@@ -434,51 +458,51 @@ class RationalBSplineSurface(Entity):
 
     @property
     def flag4(self):
-        """First direction periodic"""
+        """First direction periodic."""
         return self._flag4
 
     @property
     def flag5(self):
-        """Second direction Periodic"""
+        """Second direction periodic."""
         return self._flag5
 
     @property
     def knot1(self):
-        """First Knot Sequences"""
+        """First knot sequence."""
         return self._knot1
 
     @property
     def knot2(self):
-        """Second Knot Sequences"""
+        """Second knot sequence."""
         return self._knot2
 
     @property
     def weights(self):
-        """First Knot Sequences"""
+        """Control-point weights."""
         return self._weights
 
     def control_points(self):
-        """Control points"""
+        """Control points."""
         return self._cp
 
     @property
     def u0(self):
-        """Start first parameter value"""
+        """Start first parameter value."""
         return self._u0
 
     @property
     def u1(self):
-        """End first parameter value"""
+        """End first parameter value."""
         return self._u1
 
     @property
     def v0(self):
-        """Start second parameter value"""
+        """Start second parameter value."""
         return self._v0
 
     @property
     def v1(self):
-        """End second parameter value"""
+        """End second parameter value."""
         return self._v1
 
     def _add_parameters(self, input_parameters):
@@ -516,6 +540,7 @@ class RationalBSplineSurface(Entity):
         self._v1 = parameters[-0]  # End second parameter value
 
     def __repr__(self):
+        """Return a multi-line summary of the surface parameters."""
         info = "Rational B-Spline Surface\n"
         info += "    Upper index of first sum:          %d\n" % self._k1
         info += "    Upper index of second sum:         %d\n" % self._k2
@@ -560,7 +585,7 @@ class RationalBSplineSurface(Entity):
 
     @assert_full_module_variant
     def to_geomdl(self):
-        """Return a ``geommdl.BSpline.Surface``"""
+        """Return a ``geomdl.BSpline.Surface`` built from this entity's parameters."""
         from geomdl import BSpline
 
         surf = BSpline.Surface()
@@ -581,7 +606,7 @@ class RationalBSplineSurface(Entity):
 
     @assert_full_module_variant
     def to_vtk(self, delta=0.025):
-        """Return a pyvista.PolyData Mesh
+        """Return a pyvista.PolyData mesh.
 
         Parameters
         ----------
@@ -614,11 +639,10 @@ class RationalBSplineSurface(Entity):
 
 
 class CircularArc(Entity):
-    """Circular Arc
-
-    Type 100: Simple circular arc of constant radius. Usually defined
-    with a Transformation Matrix Entity (Type 124).
+    """IGES Type 100 circular arc.
 
+    Simple circular arc of constant radius. Usually defined with a
+    Transformation Matrix Entity (Type 124).
     """
 
     def _add_parameters(self, parameters):
@@ -641,7 +665,7 @@ class CircularArc(Entity):
 
     @assert_full_module_variant
     def to_vtk(self, resolution=20):
-        """Circular arc represented as a ``pyvista.PolyData`` Mesh
+        """Return the circular arc as a ``pyvista.PolyData`` mesh.
 
         Returns
         -------
@@ -660,10 +684,12 @@ class CircularArc(Entity):
 
     @property
     def transform(self):
+        """Return the referenced :class:`Transformation` entity, if any."""
         if self._transform is not None:
             return self.iges[self._transform]
 
     def __repr__(self):
+        """Return a multi-line string with the arc's center and endpoints."""
         info = "Circular Arc\nIGES Type 100\n"
         info += f"Center: ({self.x:f}, {self.y:f})\n"
         info += f"Start:  ({self.x1:f}, {self.y1:f})\n"
@@ -673,12 +699,15 @@ class CircularArc(Entity):
 
 
 class Face(Entity):
-    """Defines a bound portion of three dimensional space (R^3) which
-    has a finite area. Used to construct B-Rep Geometries."""
+    """IGES Type 510 face.
+
+    Defines a bound portion of three-dimensional space (R^3) which has
+    a finite area. Used to construct B-Rep geometries.
+    """
 
     def _add_parameters(self, parameters):
-        """
-        Parameter Data
+        """Parse the surface pointer, outer-loop flag, and per-loop pointers.
+
         Index	Type	Name	Description
         Pointer	Surface	Underlying surface
         2	INT	N	Number of loops
@@ -698,6 +727,7 @@ class Face(Entity):
 
     @property
     def loops(self):
+        """Resolve the face's loop pointers into a list of :class:`Loop` entities."""
         loops = []
         for ptr in self.loop_pointers:
             loops.append(self.iges.from_pointer(ptr))
@@ -705,6 +735,7 @@ class Face(Entity):
         return loops
 
     def __repr__(self):
+        """Return a short identifier string for the face."""
         info = "IGES Type 510: Face\n"
         # info += 'Center: (%f, %f)\n' % (self.x, self.y)
         # info += 'Start:  (%f, %f)\n' % (self.x1, self.y1)
@@ -714,11 +745,14 @@ class Face(Entity):
 
 
 class Loop(Entity):
-    """Defines a loop, specifying a bounded face, for B-Rep
-    geometries."""
+    """IGES Type 508 loop.
+
+    Defines a loop, specifying a bounded face, for B-Rep geometries.
+    """
 
     def _add_parameters(self, parameters):
-        """Parameter Data
+        """Parse the loop's per-edge type, vertex/edge pointers, and curves.
+
         Index   Type    Name                Description
         1       INT     N                   N Edges in loop
         2	INT	Type1	            Type of Edge 1
@@ -766,22 +800,27 @@ class Loop(Entity):
     #     for
 
     def curves(self):
-        """list of curves"""
+        """Return the list of curves bounding the loop (not yet implemented)."""
         pass
 
     def __repr__(self):
+        """Return a short identifier string for the loop."""
         info = "IGES Type 508: Loop\n"
         return info
 
 
 class EdgeList(Entity):
-    """Provides a list of edges, comprised of vertices, for specifying
-    B-Rep Geometries."""
+    """IGES Type 504 edge list.
+
+    Provides a list of edges, comprised of vertices, for specifying
+    B-Rep geometries.
+    """
 
     _iges_type = 504
 
     def _add_parameters(self, parameters):
-        """
+        """Parse the edge count and per-edge curve/vertex pointer tuples.
+
         Parameter Data
         Index in list	Type of data	Name	Description
         INT	N	Number of Edges in list
@@ -819,11 +858,13 @@ class EdgeList(Entity):
     #     for
 
     def __getitem__(self, indices):
+        """Resolve the model-space curve for the edge at ``indices``."""
         # TODO: limit spline based on start and end point
         ptr = self.edges[indices]["curve1"]
         return self.iges.from_pointer(ptr)
 
     def __len__(self):
+        """Return the number of edges in the list."""
         return len(self.edges)
 
     def __repr__(self):
@@ -832,12 +873,12 @@ class EdgeList(Entity):
 
 
 class VertexList(Entity):
-    """Vertex List (Type 502 Form 1)"""
+    """IGES Type 502 Form 1 vertex list."""
 
     _iges_type = 502
 
     def _add_parameters(self, parameters):
-        """Adds Parameter Data.
+        """Add parameter data.
 
         Index in list	Type of data	Name	Description
         INT	N	Number of vertices in list

{pyiges-0.3.2 → pyiges-0.3.4}/src/pyiges/iges.py

@@ -1,3 +1,5 @@
+"""IGES file reader and the top-level :class:`Iges` container."""
+
 from tqdm import tqdm
 
 from pyiges import geometry
@@ -6,7 +8,7 @@ from pyiges.entity import Entity
 
 
 class Iges:
-    """pyiges.Iges object
+    """In-memory representation of a parsed IGES file.
 
     Parameters
     ----------
@@ -24,11 +26,12 @@ class Iges:
     """
 
     def __init__(self, filename):
+        """Read ``filename`` and populate the entity list."""
         self._read(filename)
         self._desc = ""
 
     def entities(self):
-        """Return a list of all entities
+        """Return a list of all entities.
 
         Examples
         --------
@@ -51,7 +54,7 @@ class Iges:
         merge=True,
         progress=tqdm,
     ):
-        """Converts entities to a vtk object
+        """Convert entities to a vtk object.
 
         Parameters
         ----------
@@ -124,27 +127,27 @@ class Iges:
         return items
 
     def points(self, as_vtk=False, merge=False, **kwargs):
-        """Return all points"""
+        """Return all points."""
         return self._return_type(geometry.Point, as_vtk, merge, **kwargs)
 
     def edge_lists(self, as_vtk=False, merge=False, **kwargs):
-        """All Edge Lists"""
+        """Return all edge lists."""
         return self._return_type(geometry.EdgeList, as_vtk, merge, **kwargs)
 
     def vertex_lists(self, as_vtk=False, merge=False, **kwargs):
-        """All Point Lists"""
+        """Return all point lists."""
         return self._return_type(geometry.VertexList, as_vtk, merge, **kwargs)
 
     def lines(self, as_vtk=False, merge=False, **kwargs):
-        """All lines"""
+        """Return all lines."""
         return self._return_type(geometry.Line, as_vtk, merge, **kwargs)
 
     def bsplines(self, as_vtk=False, merge=False, **kwargs):
-        """All bsplines"""
+        """Return all bsplines."""
         return self._return_type(geometry.RationalBSplineCurve, as_vtk, merge, **kwargs)
 
     def bspline_surfaces(self, as_vtk=False, merge=False, **kwargs):
-        """All bsplines
+        """Return all bspline surfaces.
 
         Examples
         --------
@@ -182,20 +185,23 @@ class Iges:
         return self._return_type(geometry.RationalBSplineSurface, as_vtk, merge, **kwargs)
 
     def circular_arcs(self, to_vtk=False, merge=False, **kwargs):
-        """All circular_arcs"""
+        """Return all circular arcs."""
         return self._return_type(geometry.CircularArc, to_vtk, merge, **kwargs)
 
     def conic_arcs(self, as_vtk=False, merge=False, **kwargs):
+        """Return all conic arcs."""
         return self._return_type(geometry.ConicArc, as_vtk, merge, **kwargs)
 
     def faces(self, as_vtk=False, merge=False, **kwargs):
+        """Return all B-Rep faces."""
         return self._return_type(geometry.Face, as_vtk, merge, **kwargs)
 
     def loops(self, as_vtk=False, merge=False, **kwargs):
+        """Return all B-Rep loops."""
         return self._return_type(geometry.Loop, as_vtk, merge, **kwargs)
 
     def _return_type(self, iges_type, to_vtk=False, merge=False, **kwargs):
-        """Return an iges type"""
+        """Return entities matching ``iges_type``, optionally tessellated and merged."""
         items = []
         for entity in self:
             if isinstance(entity, iges_type):
@@ -216,19 +222,22 @@ class Iges:
         return items
 
     def __iter__(self):
+        """Iterate over the contained entities."""
         yield from self._entities
 
     def __len__(self):
+        """Return the number of contained entities."""
         return len(self._entities)
 
     def __repr__(self):
+        """Return a short summary string with the entity count."""
         info = "pyiges.Iges object\n"
         info += "Description: %s\n" % self._desc
         info += "Number of Entities: %d" % len(self)
         return info
 
     def from_pointer(self, ptr):
-        """Return an iges object according to an iges pointer"""
+        """Return the entity addressed by an IGES pointer."""
         return self[self._pointers[ptr]]
 
     @staticmethod
@@ -405,12 +414,12 @@ class Iges:
         self._pointers = pointer_dict
 
     def __getitem__(self, index):
-        """Get an item by its pointer"""
+        """Get an item by its pointer."""
         return self._entities[self._pointers[index]]
 
     @property
     def items(self):
-        """IGES items
+        """Return the list of contained IGES entities.
 
         Examples
         --------
@@ -428,7 +437,6 @@ class Iges:
 def read(filename):
     """Read an iges file.
 
-
     Parameters
     ----------
     filename : str

pyiges-0.3.4/src/pyiges/reader.py

@@ -0,0 +1,49 @@
+"""PyVista reader-registry integration for IGES files."""
+
+import os
+
+try:
+    # On pyvista >= 0.48, raising ``LocalFileRequiredError`` from a
+    # reader entry point makes ``pv.read("http://.../foo.igs")``
+    # download the file first and retry against the local copy.
+    from pyvista import LocalFileRequiredError as _LocalFileRequiredError
+    from pyvista import has_scheme as _has_scheme
+except ImportError:  # pragma: no cover - older pyvista or no pyvista installed
+    _LocalFileRequiredError = None
+    _has_scheme = None
+
+from pyiges.iges import Iges
+
+
+def read_as_mesh(filename, merge=True):
+    """Read an IGES file and return it as a PyVista mesh.
+
+    Wraps :class:`pyiges.Iges` and converts all supported entities to
+    a PyVista object via :meth:`pyiges.Iges.to_vtk`. Suitable for use
+    as a PyVista reader-registry entry point.
+
+    Parameters
+    ----------
+    filename : str | os.PathLike
+        Path to the IGES file.
+    merge : bool, default: True
+        If ``True``, return a single :class:`pyvista.PolyData`
+        containing all converted entities. If ``False``, return a
+        :class:`pyvista.MultiBlock`.
+
+    Returns
+    -------
+    pyvista.PolyData or pyvista.MultiBlock
+        The converted geometry.
+
+    Raises
+    ------
+    pyvista.LocalFileRequiredError
+        If a remote URI is passed and ``pyvista >= 0.48`` is installed.
+        The PyVista reader registry uses this to download the file and
+        retry against the local copy.
+    """
+    fname = os.fspath(filename)
+    if _has_scheme is not None and _has_scheme(fname):
+        raise _LocalFileRequiredError
+    return Iges(fname).to_vtk(merge=merge)

pyiges-0.3.2/src/pyiges/faces.py

@@ -1,19 +0,0 @@
-"""
-Face (Type 510)
-Defines a bound portion of three dimensional space (R^3) which has a
-finite area. Used to construct B-Rep Geometries.
-
-Parameter Data
-Index in list	Type of data	Name	Description
-Pointer	Surface	Underlying surface
-2	INT	N	Number of loops
-3	BOOL	Flag	Outer loop flag:
-True indicates Loop1 is outer loop.
-False indicates no outer loop.
-4	Pointer	Loop1	Pointer to first loop of the face
-.
-.	.
-.	.
-.
-3+N	Pointer	LoopN	Pointer to last loop of the face
-"""