pyaltiumlib 0.1.0__tar.gz

pyaltiumlib-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Chris Hoyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyaltiumlib-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.2
+Name: pyaltiumlib
+Version: 0.1.0
+Summary: PyAltiumLib is a tool to read Altium Designer library files.
+Home-page: https://github.com/ChrisHoyer/pyAltiumLib.git
+Author: Chris Hoyer
+Author-email: info@chrishoyer.de
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: olefile>=0.47
+Requires-Dist: svgwrite>=1.4.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# pyAltiumLib
+
+PyAltiumLib is a tool to read Altium Designer library files. The included components are extracted. Metadata such as the description and the name of the component can be listed. It is also possible to visualize the component using the svgwrite package.
+
+See full documentation here: [ReadTheDocs](https://pyaltiumlib.readthedocs.io/)
+
+## Example - Read the File and Retrieve Components
+
+Load the file and retrieve the list of components.
+
+```python
+import pyaltiumlib
+
+# Path to the .schlib or .pcblib file
+filepath = "Libfile.schlib"
+
+# Load File
+LibFile = pyaltiumlib.read(filepath)
+
+# Read Meta Data
+json = LibFile.read_meta()
+
+# Get a List of All Components
+all_parts = LibFile.list_parts()
+```
+
+## Example - Render Components as SVG
+
+Render each component as an SVG file. The components are saved as individual SVG files in the img_sch directory.
+
+```python
+import svgwrite
+
+# Iterate over all components to draw them
+for partname in all_parts:
+
+    # Choose element
+    Component = LibFile.get_part(partname)
+
+    # Create a new image with a white background
+    dwg = svgwrite.Drawing(f"img_sch/{partname}.svg", size=(400, 400))
+
+    # Draw component on svg drawing with size 400px 400px
+    Component.draw_svg(dwg, 400, 400)
+
+    # Save the SVG
+    dwg.save()
+```

pyaltiumlib-0.1.0/README.md

@@ -0,0 +1,48 @@
+# pyAltiumLib
+
+PyAltiumLib is a tool to read Altium Designer library files. The included components are extracted. Metadata such as the description and the name of the component can be listed. It is also possible to visualize the component using the svgwrite package.
+
+See full documentation here: [ReadTheDocs](https://pyaltiumlib.readthedocs.io/)
+
+## Example - Read the File and Retrieve Components
+
+Load the file and retrieve the list of components.
+
+```python
+import pyaltiumlib
+
+# Path to the .schlib or .pcblib file
+filepath = "Libfile.schlib"
+
+# Load File
+LibFile = pyaltiumlib.read(filepath)
+
+# Read Meta Data
+json = LibFile.read_meta()
+
+# Get a List of All Components
+all_parts = LibFile.list_parts()
+```
+
+## Example - Render Components as SVG
+
+Render each component as an SVG file. The components are saved as individual SVG files in the img_sch directory.
+
+```python
+import svgwrite
+
+# Iterate over all components to draw them
+for partname in all_parts:
+
+    # Choose element
+    Component = LibFile.get_part(partname)
+
+    # Create a new image with a white background
+    dwg = svgwrite.Drawing(f"img_sch/{partname}.svg", size=(400, 400))
+
+    # Draw component on svg drawing with size 400px 400px
+    Component.draw_svg(dwg, 400, 400)
+
+    # Save the SVG
+    dwg.save()
+```

pyaltiumlib-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyaltiumlib-0.1.0/setup.py

@@ -0,0 +1,37 @@
+from pathlib import Path
+from setuptools import setup, find_packages
+
+AUTHOR_NAME = 'Chris Hoyer'
+AUTHOR_EMAIL = 'info@chrishoyer.de'
+
+ROOT = Path(__file__).resolve().parent
+
+# get latest version from source code
+def get_version():
+    v = {}
+    for line in (ROOT / "src" / "pyaltiumlib" / "__init__.py").read_text().splitlines():
+        if line.strip().startswith('__version__'):
+            exec(line, v)
+            return v['__version__']
+    raise IOError('__version__ string not found')
+
+# get description from readme.md
+def get_description():  
+    long_description = ""
+    with open("README.md", "r") as f:
+        long_description = f.read()
+    return long_description    
+
+setup(name='pyaltiumlib',
+      version=get_version(),
+      description='PyAltiumLib is a tool to read Altium Designer library files.',
+      url='https://github.com/ChrisHoyer/pyAltiumLib.git',
+      author=AUTHOR_NAME,
+      author_email=AUTHOR_EMAIL,
+      packages=find_packages(where="src"),
+      install_requires=['olefile>=0.47', 'svgwrite>=1.4.3'],
+      package_dir={"": "src"},
+      python_requires=">=3.7",
+      long_description=get_description(),
+      long_description_content_type="text/markdown",    
+      )

pyaltiumlib-0.1.0/src/pyaltiumlib/__init__.py

@@ -0,0 +1,58 @@
+"""
+pyAltiumLib is a reader and renderer for Altium Library files
+implemented in Python.
+"""
+
+AUTHOR_NAME = 'Chris Hoyer'
+AUTHOR_EMAIL = 'info@chrishoyer.de'
+CYEAR = '2024-2025'
+
+__version__ = "0.1.0"
+__author__ = "Chris Hoyer <info@chrishoyer.de>"
+
+import os
+from typing import Union
+from pyaltiumlib.schlib.lib import SchLib
+from pyaltiumlib.pcblib.lib import PcbLib
+
+# Set up logging
+import logging
+logger = logging.getLogger(__name__)
+
+@staticmethod
+def read(filepath: str) -> Union[SchLib, PcbLib]:
+    """
+    Reads an Altium library file and returns the corresponding library object.
+
+    This method determines whether the given file is a schematic library (`.SchLib`) 
+    or a PCB library (`.PcbLib`) and returns the appropriate class instance.
+
+    :param filepath: The path to the Altium library file.
+    :type filepath: str
+
+    :return: An instance of either :class:`SchLib` or :class:`PcbLib`, 
+             depending on the file type.
+    :rtype: :class:`pyaltiumlib.schlib.lib.SchLib` or :class:`pyaltiumlib.pcblib.lib.PcbLib`
+
+    :raises FileNotFoundError: If the specified file does not exist.
+    :raises ValueError: If the file type is not recognized as `.SchLib` or `.PcbLib`.
+    """
+    if not os.path.isfile( filepath ): 
+        logger.error(f"{filepath} does not exist.")
+        raise
+
+    # Choose the correct class        
+    if filepath.lower().endswith('.schlib'):
+        return SchLib( filepath ) 
+    
+    elif filepath.lower().endswith('.pcblib'):
+        return PcbLib( filepath ) 
+        
+    else:
+        logger.error(f"Invalid file type: {filepath}.")
+        raise
+    
+
+
+
+

pyaltiumlib-0.1.0/src/pyaltiumlib/base.py

@@ -0,0 +1,172 @@
+from pyaltiumlib.datatypes import ParameterColor
+
+import olefile
+from typing import List, Optional, Dict, Any
+
+# Set up logging
+import logging
+logger = logging.getLogger(__name__)
+
+class GenericLibFile:
+    """
+    Base class for handling Altium Designer library files.
+
+    This class provides fundamental functionality for reading library files
+    in Altium Designer format.
+    
+    :param string filepath: The path to the library file
+    
+    :raises FileNotFoundError: If file is not a supported file.
+    """
+    
+    LibType = None
+    """
+    `string` that specifies the type of the library.
+    """
+
+    LibHeader = ''
+    """`string` that contains the file path to the library.
+    """
+
+    FilePath = ''
+    """
+    `string` that stores the header information of the library.
+    """
+    
+    ComponentCount = 0
+    """
+    `int` with total number of components in the library.
+    """
+
+    Parts = []
+    """
+    `List[any]` is a collection of components derived from :class:`pyaltiumlib.libcomponent.LibComponent` in their specific class 
+    contained in the library.
+    """    
+    
+    def __init__(self, filepath: str):
+        """
+        Initialize a GenericLibFile object.
+        """
+        if not olefile.isOleFile( filepath ): 
+            logger.error(f"{filepath} is not a supported file.")
+            raise
+            
+        self.LibType = type(self)        
+        self.FilePath = filepath    
+        
+        self._olefile = None
+        self._olefile_open = False
+         
+        # extracted file content
+        self._FileHeader = None
+        
+        self._BackgroundColor = ParameterColor.from_hex("#6D6A69")  
+
+
+    def __repr__(self) -> Dict:
+        """
+        Converts public attributes of the high level file to a dictionary.
+
+        :return: A dict representation of the content of the object
+        :rtype: Dict
+        """
+        return self.read_meta()
+    
+# =============================================================================
+#     External access 
+# =============================================================================
+
+    def read_meta(self) -> Dict:
+        """
+        Converts public attributes of the high level file to a dictionary.
+
+        :return: A dict representation of the content of the object
+        :rtype: Dict
+        """
+        public_attributes = {
+            key: value if isinstance(value, str) else str(value)
+            for key, value in self.__dict__.items()
+            if not key.startswith("_")
+            }
+        return public_attributes        
+    
+ 
+    def list_parts(self) -> List[str]:
+        """
+        List the names of all parts in the library.
+
+        :return: A list of part names
+        :rtype: List[str]
+        """
+        return [x.Name for x in self.Parts]
+
+
+    def get_part(self, name: str) -> Optional[Any]:
+        """
+        Get a part of the library by its name.
+        
+        :param string name: The name of the part.
+
+        :return: The part class derived from :class:`pyaltiumlib.libcomponent.LibComponent` if found, otherwise None.
+        :rtype: Optional[Any]
+        """
+        for part in self.Parts:
+            if part.Name == name:
+                return part
+        return None
+    
+
+# =============================================================================
+#     Internal file handling related functions
+# =============================================================================
+
+    def _OpenFile(self) -> None:
+        """
+        Open the library file for reading.
+        """        
+        if self._olefile_open:
+            raise ValueError(f"file: { self.FilePath }. Already open!")
+                
+        try:
+            self._olefile = olefile.OleFileIO( self.FilePath )
+            self._olefile_open = True
+        except Exception as e:
+            logger.error(f"Failed to open file: {self.FilePath}. Error: {e}")
+            raise
+
+    def _OpenStream(self, container: str, stream: str) -> Any:
+        """
+        Open a stream within the library file.
+
+        Args:
+            container (str): The container name.
+            stream (str): The stream name.
+
+        Returns:
+            Any: The opened stream.
+        """                
+        if not self._olefile_open:
+            logger.error(f"file: { self.FilePath }. File not open!")
+            raise
+                    
+        if not container == "":
+
+            illegal_characters = '<>:"/\\|?*\x00'
+            container = "".join("_" if char in illegal_characters else char for char in container)
+            
+            if not self._olefile.exists( container ):
+                logger.error(f"Part '{container}' does not exist in file '{self.FilePath}'!")
+                raise
+        
+        return self._olefile.openstream( f"{container}/{stream}" if container else stream )
+
+
+    def _CloseFile(self) -> None:
+        """
+        Close the library file.
+        """
+        if hasattr(self, '_olefile') and self._olefile is not None:
+            self._olefile.close()
+            self._olefile_open = False
+

pyaltiumlib-0.1.0/src/pyaltiumlib/datatypes/__init__.py

@@ -0,0 +1,48 @@
+"""
+ 
+"""
+
+from .parametercollection import ParameterCollection
+from .parametercolor import ParameterColor
+from .parameterfont import ParameterFont
+from .binaryreader import BinaryReader
+from .coordinate import Coordinate, CoordinatePoint
+
+# Schematic related
+from .schematicpin import SchematicPin
+from .schematicmapping import (
+    SchematicLineWidth, SchematicLineStyle, SchematicLineShape,
+    SchematicPinSymbol, SchematicPinElectricalType, SchematicTextOrientation,
+    SchematicTextJustification
+    )
+
+# PCB related
+from .pcblayerdefinition import PCBLayerDefinition
+from .pcbmapping import ( PCBPadShape, PCBHoleShape, PCBStackMode, 
+                         PCBTextJustification, PCBStrokeFont, PCBTextKind
+                         )
+
+
+__all__ = [
+    "ParameterCollection",
+    "ParameterColor",
+    "ParameterFont",
+    "BinaryReader",
+    "Coordinate",
+    "CoordinatePoint",
+    "SchematicPin",
+    "SchematicLineWidth",
+    "SchematicLineStyle",
+    "SchematicLineShape",
+    "SchematicPinSymbol",
+    "SchematicPinElectricalType",
+    "SchematicTextOrientation",
+    "SchematicTextJustification",
+    "PCBLayerDefinition",
+    "PCBPadShape",
+    "PCBStackMode",
+    "PCBHoleShape",
+    "PCBTextJustification",
+    "PCBStrokeFont",
+    "PCBTextKind"
+]

pyaltiumlib-0.1.0/src/pyaltiumlib/datatypes/binaryreader.py

@@ -0,0 +1,125 @@
+from pyaltiumlib.datatypes.coordinate import Coordinate, CoordinatePoint
+
+class BinaryReader:
+    
+    def __init__(self, data):
+        self.data = data
+        self.offset = 0
+
+    @classmethod        
+    def from_stream(cls, stream, size_length=4):
+        length = int.from_bytes( stream.read( size_length ), "little" )
+        data = stream.read( length )
+        
+        if len(data) != length:
+            raise ValueError("Stream does not match the declared block length.")        
+        
+        return cls( data )       
+
+    def has_content(self):
+        return not len(self.data) == 0
+    
+    def length(self):
+        return len(self.data)
+        
+    def read(self, length):
+                    
+        if self.offset + length > len(self.data):
+            raise ValueError("Not enough data to read the requested length.")
+        
+        result = self.data[self.offset:self.offset + length]
+        self.offset += length
+        return result        
+
+    def read_byte(self):
+        if self.offset + 1 > len(self.data):
+            raise ValueError("Not enough data to read.")
+        return self.read(1)
+
+    def read_int8(self, signed=False):
+        return int.from_bytes(self.read_byte(), signed=signed)
+    
+    def read_int16(self, signed=False):
+        if self.offset + 2 > len(self.data):
+            raise ValueError("Not enough data to read an Int16.")
+        
+        value = int.from_bytes(self.data[self.offset:self.offset + 2], byteorder="little", signed=signed)
+        self.offset += 2
+        return value
+    
+    def read_int32(self, signed=False):
+        if self.offset + 4 > len(self.data):
+            raise ValueError("Not enough data to read an Int32.")
+        
+        value = int.from_bytes(self.data[self.offset:self.offset + 4], byteorder="little", signed=signed)
+        self.offset += 4
+        return value
+
+    def read_double(self):
+        if self.offset + 8 > len(self.data):
+            raise ValueError("Not enough data to read a Double.")
+
+        raw_bytes = self.data[self.offset:self.offset + 8]
+        self.offset += 8
+        return self._decode_double(raw_bytes)
+
+    def read_string_block(self, size_string=1):
+        
+        length_string = int.from_bytes( self.read( size_string ), "little" )
+        string_data = self.read( length_string )
+                 
+        if len(string_data) != length_string:
+            raise ValueError("String does not match the declared string length.")        
+        
+        return string_data.decode('windows-1252')
+
+    def read_bin_coord(self, scaley=-1.0):
+        x = self.read(4)
+        y = self.read(4)
+        return CoordinatePoint( Coordinate.parse_bin(x), Coordinate.parse_bin(y, scale=scaley)) 
+
+    def read_unicode_text(self, length=32, encoding='utf-16-le'):
+        
+        pos = self.offset
+        data = []
+    
+        while len(data) < length:
+            if self.offset + 2 > len(self.data):
+                raise ValueError("Not enough data to read.")
+            
+            # Read 2 bytes (1 Unicode character)
+            unicode_char = self.read(2)
+            if unicode_char == b'\x00\x00':  # Null terminator
+                break
+            data.extend(unicode_char)
+        
+        # Ensure we skip the remaining bytes to read exactly `length` bytes
+        self.offset = pos + length
+        
+        return bytes(data).decode(encoding)
+    
+    
+# =================================0
+
+    def _decode_double(self, raw_bytes):
+        # Decode IEEE 754 double-precision format
+        value = 0
+        for i, b in enumerate(raw_bytes):
+            value |= b << (i * 8)
+
+        sign = (value >> 63) & 0x1
+        exponent = (value >> 52) & 0x7FF
+        mantissa = value & ((1 << 52) - 1)
+
+        if exponent == 0x7FF:
+            if mantissa == 0:
+                return float('inf') if sign == 0 else float('-inf')
+            return float('nan')
+
+        if exponent == 0:
+            result = (mantissa / (1 << 52)) * (2 ** (-1022))
+        else:
+            result = (1 + (mantissa / (1 << 52))) * (2 ** (exponent - 1023))
+
+        return -result if sign == 1 else result
+