cwrap 1.6.1__tar.gz → 1.6.9__tar.gz

cwrap-1.6.9/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

cwrap-1.6.9/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

cwrap-1.6.9/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+**Issue**
+Resolves #my_issue
+
+
+**Approach**
+_Short description of the approach_

cwrap-1.6.9/.github/workflows/build.yml

@@ -0,0 +1,73 @@
+name: Python package
+
+on:
+  push:
+    branches:
+      - main
+      - 'version-**'
+    tags: "*"
+  pull_request:
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        pip install .
+        pip install -r requirements.txt
+
+    - name: Test
+      run: |
+        pytest -sv tests
+
+    - name: Style
+      run: |
+        ruff check
+        ruff format --check
+
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build]
+
+    # If this is a tagged release
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Build wheel
+      run: |
+        pip install --upgrade pip build
+        python -m build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@v1.12.3
+      with:
+        user: __token__
+        password: ${{ secrets.pypi_password }}

{cwrap-1.6.1 → cwrap-1.6.9}/.gitignore

@@ -89,4 +89,4 @@ ENV/
 .ropeproject
 
 # don't track setuptools-generated version
-cwrap/version.py
+src/cwrap/version.py

cwrap-1.6.9/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at . All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

cwrap-1.6.9/CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contributing
+_cwrap_ is deprecated and will not see any new features. However, issues and critical bug fixed are accepted still.
+
+We require a unit tests for bug fix pull-requests.

cwrap-1.6.9/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.2
+Name: cwrap
+Version: 1.6.9
+Summary: cwrap - ctypes blanket
+Author-email: Equinor ASA <fg_sib-scout@equinor.com>
+License: GPL-3.0
+Project-URL: Repository, https://github.com/equinor/cwrap
+Platform: all
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Other Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# cwrap
+
+cwrap is a Python wrapper around C code, building upon ctypes.
+
+# Examples
+
+See `examples/`
+
+# Installing
+```
+pip install cwrap
+```
+
+# Running tests
+Clone this repo and cd into it, then:
+
+```
+pip install -r requirements.txt
+python -m pytest -sv tests
+```

cwrap-1.6.9/README.md

@@ -0,0 +1,20 @@
+# cwrap
+
+cwrap is a Python wrapper around C code, building upon ctypes.
+
+# Examples
+
+See `examples/`
+
+# Installing
+```
+pip install cwrap
+```
+
+# Running tests
+Clone this repo and cd into it, then:
+
+```
+pip install -r requirements.txt
+python -m pytest -sv tests
+```

cwrap-1.6.9/SECURITY.md

@@ -0,0 +1,18 @@
+# Security Policy
+
+If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it:
+
+1. **Do not** create a public GitHub issue for the vulnerability.
+2. Follow our guideline for Responsible Disclosure Policy at [https://www.equinor.com/about-us/csirt](https://www.equinor.com/about-us/csirt) to report the issue
+
+The following information will help us triage your report more quickly:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+We prefer all communications to be in English.

{cwrap-1.6.1 → cwrap-1.6.9}/examples/map/ex_map.py

@@ -6,28 +6,29 @@ from cwrap.clib import lib_name
 class ExMapPrototype(Prototype):
     _LIB_NAME = "ex_map"
 
-    lib_file = lib_name( _LIB_NAME )
+    lib_file = lib_name(_LIB_NAME)
     if not lib_file:
-        raise ImportError("Cannot find library " + _LIB_NAME )
-    lib = ctypes.CDLL( lib_file , ctypes.RTLD_GLOBAL )
+        raise ImportError("Cannot find library " + _LIB_NAME)
+    lib = ctypes.CDLL(lib_file, ctypes.RTLD_GLOBAL)
 
-    def __init__(self , prototype , bind = True):
-        super(ExMapPrototype , self).__init__( ExMapPrototype.lib , prototype , bind = bind)
+    def __init__(self, prototype, bind=True):
+        super(ExMapPrototype, self).__init__(ExMapPrototype.lib, prototype, bind=bind)
 
 
 class ExMap(BaseCClass):
     """
     Super thin wrapper around a std::map<char*, int>.
     """
+
     TYPE_NAME = "ex_map"
 
-    _alloc  = ExMapPrototype("void* ex_map_alloc()", bind=False)
-    _free   = ExMapPrototype("void  ex_map_free(ex_map)")
-    _size   = ExMapPrototype("int   ex_map_size(ex_map)")
+    _alloc = ExMapPrototype("void* ex_map_alloc()", bind=False)
+    _free = ExMapPrototype("void  ex_map_free(ex_map)")
+    _size = ExMapPrototype("int   ex_map_size(ex_map)")
     _insert = ExMapPrototype("void  ex_map_insert(ex_map, char*, int)")
-    _find   = ExMapPrototype("int   ex_map_find(ex_map, char*)")
-    _count  = ExMapPrototype("int   ex_map_count(ex_map, char*)")
-    _at     = ExMapPrototype("char* ex_map_get_key_at(ex_map, int)")
+    _find = ExMapPrototype("int   ex_map_find(ex_map, char*)")
+    _count = ExMapPrototype("int   ex_map_count(ex_map, char*)")
+    _at = ExMapPrototype("char* ex_map_get_key_at(ex_map, int)")
 
     def __init__(self):
         c_ptr = self._alloc()
@@ -49,20 +50,21 @@ class ExMap(BaseCClass):
         if key in self:
             return self._find(key)
         else:
-            raise KeyError('Key %s not found in map' % key)
+            raise KeyError("Key %s not found in map" % key)
 
     def __str__(self):
         ks = self.keys()
         kv = ["'%s': %s" % (k, self[k]) for k in ks]
-        return '{%s}' % (', '.join(kv))
+        return "{%s}" % (", ".join(kv))
 
     def free(self):
         self._free()
 
+
 em = ExMap()
 em["Abc"] = 42
 em["Jean-Paul"] = 3
-em["cwrap"] =  2
+em["cwrap"] = 2
 em["jokva"] = 17
 
 if em["Abc"] != 42:

cwrap-1.6.9/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["setuptools", "setuptools_scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cwrap"
+description = "cwrap - ctypes blanket"
+authors = [
+    { name = "Equinor ASA", email = "fg_sib-scout@equinor.com" },
+]
+requires-python = ">=3.10"
+readme = "README.md"
+license = { text = "GPL-3.0" }
+classifiers=[
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Other Environment",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Natural Language :: English",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Utilities",
+]
+dynamic = ["version"]
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/equinor/cwrap"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+platforms = ["all"]
+
+[tool.setuptools_scm]
+write_to = "src/cwrap/version.py"
+
+[tool.ruff]
+src = ["src"]
+line-length = 88
+exclude = ["examples"]
+
+[tool.ruff.lint]
+select = [
+  "W",   # pycodestyle
+  "I",   # isort
+  "B",   # flake-8-bugbear
+  "SIM", # flake-8-simplify
+  "F",   # pyflakes
+  "UP",  # pyupgrade
+  "PL",  # pylint
+]
+
+ignore = ["PLW2901", # redefined-loop-name
+          "PLR2004", # magic-value-comparison
+          "PLR0915", # too-many-statements
+          "PLR0912", # too-many-branches
+          "PLR5501", # collapsible-else-if
+          "PLR0911",  # too-many-return-statements
+]

cwrap-1.6.9/requirements.txt

@@ -0,0 +1,2 @@
+pytest
+ruff==0.9.2

{cwrap-1.6.1 → cwrap-1.6.9/src}/cwrap/__init__.py

@@ -28,26 +28,36 @@ the process of interacting with a C library:
      FILE pointer.
 """
 
-try: from .version import version as __version__
-except ImportError: __version__ = '0.0.0'
+try:
+    from .version import version as __version__
+except ImportError:
+    __version__ = "0.0.0"
 
-__author__ = 'Statoil ASA'
-__copyright__ = 'Copyright 2016, Statoil ASA'
+__author__ = "Statoil ASA"
+__copyright__ = "Copyright 2016, Statoil ASA"
 __credits__ = __author__
-__license__ = 'GPL'
+__license__ = "GPL"
 __maintainer__ = __author__
-__email__ = 'fg_gpl@statoil.com'
-__status__ = 'Prototype'
+__email__ = "fg_gpl@statoil.com"
+__status__ = "Prototype"
 
 from .basecclass import BaseCClass
 from .basecenum import BaseCEnum
 from .basecvalue import BaseCValue
-
-from .cfile import CFILE, copen as open
-from .clib import load, lib_name
-
+from .cfile import CFILE
+from .cfile import copen as open
+from .clib import lib_name, load
 from .metacwrap import MetaCWrap
-from .prototype import REGISTERED_TYPES, Prototype, PrototypeError
-
-__all__ = ['BaseCClass', 'BaseCEnum', 'BaseCValue', 'CFILE', 'open',
-           'MetaCWrap', 'Prototype', 'load', 'lib_name']
+from .prototype import REGISTERED_TYPES, Prototype, PrototypeError  # noqa
+
+__all__ = [
+    "BaseCClass",
+    "BaseCEnum",
+    "BaseCValue",
+    "CFILE",
+    "open",
+    "MetaCWrap",
+    "Prototype",
+    "load",
+    "lib_name",
+]

{cwrap-1.6.1 → cwrap-1.6.9/src}/cwrap/basecclass.py

@@ -14,16 +14,12 @@
 #  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
 #  for more details.
 
-from __future__ import (absolute_import, division,
-                        print_function, unicode_literals)
-
-import six
-
 import ctypes
+
 from .metacwrap import MetaCWrap
 
-@six.add_metaclass(MetaCWrap)
-class BaseCClass(object):
+
+class BaseCClass(metaclass=MetaCWrap):
     namespaces = {}
 
     def __init__(self, c_pointer, parent=None, is_reference=False):
@@ -31,25 +27,30 @@ class BaseCClass(object):
             raise ValueError("Must have a valid (not null) pointer value!")
 
         if c_pointer < 0:
-            raise ValueError("The pointer value is negative! This may be correct, but usually is not!")
+            raise ValueError(
+                "The pointer value is negative! This may be correct, but usually is not!"
+            )
 
         self.__c_pointer = c_pointer
         self.__parent = parent
         self.__is_reference = is_reference
 
     def __new__(cls, *more, **kwargs):
-        obj = super(BaseCClass, cls).__new__(cls)
+        obj = super().__new__(cls)
         obj.__c_pointer = None
         obj.__parent = None
         obj.__is_reference = False
 
         return obj
 
+    def is_initialized(self):
+        return self._address() is not None
+
     def _address(self):
         return self.__c_pointer
 
     def _ad_str(self):
-        return 'at 0x%x' % self._address()
+        return f"at 0x{self._address():x}"
 
     @classmethod
     def from_param(cls, c_class_object):
@@ -58,14 +59,16 @@ class BaseCClass(object):
 
         if c_class_object is None:
             return ctypes.c_void_p()
-        else:
-            return ctypes.c_void_p(c_class_object.__c_pointer)
+
+        return ctypes.c_void_p(c_class_object.__c_pointer)
 
     @classmethod
     def createPythonObject(cls, c_pointer):
         if c_pointer is not None:
             new_obj = cls.__new__(cls)
-            BaseCClass.__init__(new_obj, c_pointer=c_pointer, parent=None, is_reference=False)
+            BaseCClass.__init__(
+                new_obj, c_pointer=c_pointer, parent=None, is_reference=False
+            )
             return new_obj
         else:
             return None
@@ -74,7 +77,9 @@ class BaseCClass(object):
     def createCReference(cls, c_pointer, parent=None):
         if c_pointer is not None:
             new_obj = cls.__new__(cls)
-            BaseCClass.__init__(new_obj, c_pointer=c_pointer, parent=parent, is_reference=True)
+            BaseCClass.__init__(
+                new_obj, c_pointer=c_pointer, parent=parent, is_reference=True
+            )
             return new_obj
         else:
             return None
@@ -87,7 +92,6 @@ class BaseCClass(object):
         self.__is_reference = True
         self.__parent = parent
 
-
     def setParent(self, parent=None):
         if self.__is_reference:
             self.__parent = parent
@@ -97,7 +101,7 @@ class BaseCClass(object):
         return self
 
     def isReference(self):
-        """ @rtype: bool """
+        """@rtype: bool"""
         return self.__is_reference
 
     def parent(self):
@@ -110,7 +114,7 @@ class BaseCClass(object):
         if isinstance(other, BaseCClass):
             return self.__c_pointer == other.__c_pointer
         else:
-            return super(BaseCClass , self) == other
+            return super() == other
 
     def __hash__(self):
         # Similar to last resort comparison; this returns the hash of the
@@ -120,37 +124,31 @@ class BaseCClass(object):
     def free(self):
         raise NotImplementedError("A BaseCClass requires a free method implementation!")
 
-    def _create_repr(self, args = ''):
+    def _create_repr(self, args=""):
         """Representation on the form (e.g.) 'EclFile(...) at 0x1729'."""
-        return "{0}({1}) {2}".format(self.__class__.__name__, args, self._ad_str())
+        return f"{self.__class__.__name__}({args}) {self._ad_str()}"
 
     def __repr__(self):
         """Representation on the form (e.g.) 'EclFile(...) at 0x1729'."""
         return self._create_repr()
 
     def __del__(self):
-        if self.free is not None:
-            if not self.__is_reference:
-                # Important to check the c_pointer; in the case of failed object creation
-                # we can have a Python object with c_pointer == None.
-                if self.__c_pointer:
-                    self.free()
+        if self.free is not None and not self.__is_reference and self.__c_pointer:
+            # Important to check the c_pointer; in the case of failed object creation
+            # we can have a Python object with c_pointer == None.
+            self.free()
 
     def _invalidateCPointer(self):
         self.__c_pointer = None
 
-
     def __bool__(self):
         """The BaseCClass instance will evaluate to true if it is bound to an
         underlying C object, otherwise it will evaluate to False. More
         elaborate bool tests should be implemented in the derived
         class.
         """
-        if self.__c_pointer:
-            return True
-        else:
-            return False
 
+        return bool(self.__c_pointer)
 
     def __nonzero__(self):
-        return self.__bool__( )
+        return self.__bool__()