valarray 0.4rc1__tar.gz → 0.4.2__tar.gz

{valarray-0.4rc1 → valarray-0.4.2}/.gitignore

@@ -3,6 +3,7 @@
 .coverage
 *egg-info
 dist*
+tach*
 
 ut_*
 temp*

{valarray-0.4rc1 → valarray-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valarray
-Version: 0.4rc1
+Version: 0.4.2
 Summary: Library for validating numpy arrays.
 Project-URL: Homepage, https://codeberg.org/jfranek/valarray
 Author-email: "J. Franek" <franek.j27@email.cz>
@@ -14,11 +14,11 @@ Requires-Python: >=3.7
 Requires-Dist: numpy>=2
 Description-Content-Type: text/markdown
 
-![](assets/images/valarray_logo.svg)
+![valarray logo](https://codeberg.org/jfranek/valarray/raw/branch/main/assets/images/valarray_logo.svg)
 
 In short, library for validating numpy arrays that also helps with static analysis and documentation. In long, see [Library rationale](#library-rationale).
 
-Currently intended primarily as a personal/hobby project (see [Caveats](#caveats))
+Currently intended primarily as a personal/hobby project (see [Caveats](#caveats)). Also not considered stable (see [Breaking changes](#breaking-changes)). 
 
 I have gotten away with using it in a professional setting, but YMMV. 
 
@@ -55,8 +55,10 @@ except ValidationException as v_exc:
 >>>         [-2.0, -6.0]
 ```
 
-# Table of contents
-- [Table of contents](#table-of-contents)
+<!-- NOTE: Headings that are used as relative links (so most of them) must have id tag defined
+(see https://github.com/pypa/readme_renderer/issues/169#issuecomment-808577486) otherwise links do not work on pypi.-->
+
+# Table of contents <!-- omit from toc -->
 - [Library rationale](#library-rationale)
   - [1) Invalid values causing unintended behaviour](#1-invalid-values-causing-unintended-behaviour)
     - [Problem](#problem)
@@ -83,13 +85,19 @@ except ValidationException as v_exc:
 - [Catching exceptions](#catching-exceptions)
   - [Special exceptions and errors](#special-exceptions-and-errors)
   - [Generic Errors](#generic-errors)
+- [Settings](#settings)
 - [Caveats](#caveats)
+- [Changelog](#changelog)
+  - [0.4.2](#042)
+  - [0.4.1](#041)
+  - [0.4](#04)
+- [Breaking changes](#breaking-changes)
 
-# Library rationale
+# Library rationale<a id="library-rationale"></a>
 This library aims to help with 3 issues encountered when working with numpy arrays:
 
-## 1) Invalid values causing unintended behaviour
-### Problem
+## 1) Invalid values causing unintended behaviour<a id="1-invalid-values-causing-unintended-behaviour"></a>
+### Problem<a id="problem"></a>
 Invalid values can cause crashes, or worse, cause silent failures.
 
 For example the following code fails silently when attempting to cut patches from image using bounding boxes with invalid coordinates.
@@ -123,7 +131,7 @@ for patch in patches:
 >>> (50, 200, 3)
 ```
 
-### Solution
+### Solution<a id="solution"></a>
 Validate boxes array first. If errors are encountered, print descriptive error message(s).
 
 ```python
@@ -177,8 +185,8 @@ except ValidationException as exc:
 >>>                 Field < 0 >: [-10]
 ```
 
-## 2) Limited support for static analysis
-### Problem
+## 2) Limited support for static analysis<a id="2-limited-support-for-static-analysis"></a>
+### Problem<a id="problem-1"></a>
 Support for static analysis is limited. Tools can only check whether the datatype is correct, but not shape, values or what those values actually represent.
 
 For example, the function to crop patches needs the boxes to be defined by `xmin, ymin, xmax, ymax` but doesn't throw an error if input boxes are defined by `x_center, y_center, width, height` and static analysis tools cannot detect this error using bulit-in numpy types.
@@ -222,7 +230,7 @@ for patch in patches_inv:
 >>> (0, 200, 3)
 ```
 
-### Solution
+### Solution<a id="solution-1"></a>
 `ValidatedNumpyArray` subclasses can represent these two types of boxes arrays, and can be used instead of bare numpy arrays in function/method signatures and such.
 ```python
     import numpy as np
@@ -289,8 +297,8 @@ for patch in patches_inv:
         print(patch.shape)
 ```
 
-## 3) Need for explicit documentation
-### Problem
+## 3) Need for explicit documentation<a id="3-need-for-explicit-documentation"></a>
+### Problem<a id="problem-2"></a>
 Using built-in numpy types provides only documentation for data types. Shape, values, constraints and what the array represents need to be explicitly documented either in comments or docstrings.
 
 If this type of array is used in multiple places / functions, this can cause duplicated documentation.
@@ -319,7 +327,7 @@ def cut_patches(
     return patches
 ```
 
-### Solution
+### Solution<a id="solution-2"></a>
 Defining data type, schema and constraints on a `ValidatedNumpyArray` subclass already implicitly documents them.
 
 This can be complemented by adding additional (or summary) documentation in the class docstring.
@@ -367,8 +375,8 @@ def cut_patches(
 ```
 
 
-# Validated Array
-## Defining a validated array
+# Validated Array<a id="validated-array"></a>
+## Defining a validated array<a id="defining-a-validated-array"></a>
 Subclass `ValidatedNumpyArray` and define:
 - `dtype` - expected data type specification (such as `float`, `"float64"`, `np.float64`).
     If not specified, data type is not validated.
@@ -377,7 +385,7 @@ Subclass `ValidatedNumpyArray` and define:
 - `schema` - expected shape specification (of type `valarray.numpy.axes_and_fields.AxesTuple`). For details, see [Array Schema](#array-schema).
         If not specified, shape is not validated (and no field validators are applied). 
 - `lt`/`le`/`ge`/`gt`/`eq` - basic array value constraints -> less (or equal) than, greater (or equal) than, equal to
-- `validators` - optional list of validators applied to the whole array. For details, see [Validators](##validators).
+- `validators` - optional validator or a tuple of validators applied to the whole array. For details, see [Validators](##validators).
 
 ```python
 import numpy as np
@@ -388,7 +396,7 @@ class ExampleValidatedNumpyArray(ValidatedNumpyArray):
   schema = ('batch_size', 3, 5)
 ```
 
-## Creating a validated array instance
+## Creating a validated array instance<a id="creating-a-validated-array-instance"></a>
 There are 4 ways to create a validated array instance:
 - validate an existing array
 ```python
@@ -431,7 +439,7 @@ v_arr = ExampleValidatedNumpyArray(np.array([1,2],dtype=np.float32), coerce_dtyp
 v_arr = ExampleValidatedNumpyArray(np.array([1,2],dtype=np.float32), coerce_dtype=True, validate=False)
 ``` 
 
-## Accessing array values
+## Accessing array values<a id="accessing-array-values"></a>
 You can access the underlying array using the `.array`/`.a_` property:
 ```python
 arr = v_arr.array
@@ -454,7 +462,7 @@ class SpecifiedDataTypeArray(ValidatedNumpyArray[np.float32]): ...
 arr = SpecifiedDataTypeArray(...).array # np.typing.NDArray[np.float32]
 ```
 
-# Validation functions
+# Validation functions<a id="validation-functions"></a>
 Array validation is designed to be modular and composable and validation functions can be used on they own if only runtime validation is required.
 Each validation function returns a list of errors, from which a `ValidationException` can be raised. For details see [Catching exceptions](#catching-exceptions).
 ```python
@@ -493,7 +501,7 @@ and a "composite" validation function:
     - *returns* `NumpyInvalidArrayValuesError`/`NumpyInvalidFieldValuesError` or no errors.
 
 
-# Array schema
+# Array schema<a id="array-schema"></a>
 Schema defines expected axes, and for each axis its' fields and optionally constraints on the field values.
 
 Axes can be defined with:
@@ -514,11 +522,11 @@ schema = (
   ("field_a", Field())
 )
 ```
-## Field
+## Field<a id="field"></a>
 Defines (optional) name and value constrints for array field. More specifically:
 - `name` - descriptive name used in error messages (if missing, field index is used instead)
 - `lt`/`le`/`ge`/`gt`/`eq` - basic array value constraints -> less (or equal) than, greater (or equal) than, equal to
-- `validators` - other validators of fields values. For details, see [Validators](##validators).
+- `validators` - optional validator or a tuple of validators applied to fields values. For details, see [Validators](##validators).
 
 ```python
 from typing import Any
@@ -533,8 +541,8 @@ f1 = Field("example_named_field", ge=0)
 f2 = Field(gt=10, validators=(ExampleNumpyValidator(),))
 ```
 
-## Array schema examples
-### rectangles
+## Array schema examples<a id="array-schema-examples"></a>
+### rectangles<a id="rectangles"></a>
 An array of arbitrary number of rectangles defined by min and max coordinates which has two axes: *n_rects* and *rect*. 
 Axis *rect* is has 4 fields: *x_min*,*y_min*,*x_max*,*y_max*, where values must be greater or equal to zero.
 
@@ -567,10 +575,10 @@ arr = np.array(
 Rect.validate(arr)
 ```
 
-# Validators
+# Validators<a id="validators"></a>
 Validators are objects that perform arbitrary validation of array or field values defined by user.
 
-## Defining a validator
+## Defining a validator<a id="defining-a-validator"></a>
 Validators must subclass `valarray.numpy.NumpyValidator` Abstract Base Class 
 and implement the `.validate()` method that takes an array as an input and results in success/failure of validation using these options:
 
@@ -583,7 +591,7 @@ and implement the `.validate()` method that takes an array as an input and resul
     - *returns* `False`
     - *raises* `ValueError`
 
-### ValidationResult
+### ValidationResult<a id="validationresult"></a>
 Contains result status of validation `status="OK"`/`status="FAIL"`
 
 Can also optionally contain:
@@ -615,7 +623,7 @@ indices = (np.array([0, 1, 1]), np.array([1, 0, 1]))
 res = ValidationResult(status="FAIL", indices_invalid=indices, msg="Optional error message.")
 ```
 
-### Example Validator
+### Example Validator<a id="example-validator"></a>
 ```python
 from dataclasses import dataclass
 from typing import Literal
@@ -652,7 +660,7 @@ class ExampleIsEvenValidator(NumpyValidator[np.uint8]):
                 return ValidationResult("FAIL", indices_invalid=~even)
 ```
 
-# Catching exceptions
+# Catching exceptions<a id="catching-exceptions"></a>
 Failed validation results in `valarray.core.errors_exceptions.ValidationException` being raised containing list of errors responsible (and name of array class if available).
 
 Main error types are:
@@ -678,21 +686,49 @@ except ValidationException as exc:
     axis_errs = exc.errs[(IncorrectAxSizesError, IncorrectAxNumberError)]
 ```
 
-## Special exceptions and errors
+## Special exceptions and errors<a id="special-exceptions-and-errors"></a>
 There are two special subclasses of `ValidationException` with associated validation errors raised during [instantiation](#creating-a-validated-array-instance):
 - `CreateArrayException` -> `CannotCreateArrayError` - Array cannot be created from supplied object.
 - `CoerceDTypeException` -> `CannotCoerceDTypeError` - If array data type cannot be coerced when creating array with `ValidatedArray(coerce_dtype=True)`
 
 
-## Generic Errors
+## Generic Errors<a id="generic-errors"></a>
 These error types have subclasses ensuring proper type hints:
 - `IncorrectDTypeError` -> `NumpyIncorrectDTypeError`
 - `CannotCoerceDTypeError` -> `NumpyCannotCoerceDTypeError`
 - `InvalidArrayValuesError` -> `NumpyInvalidArrayValuesError`
 - `InvalidFieldValuesError` -> `NumpyInvalidFieldValuesError`
 
+# Settings<a id="settings"></a>
+Global settings for the library are defined in `valarray.settings` and can be modified using environment variables.
+| ***variable name*** | ***environment variable***   | default value | description                                         |
+|---------------------|------------------------------|---------------|-----------------------------------------------------|
+| function_cache_size | VALARRAY_FUNCTION_CACHE_SIZE | 512           | cache size for (internal) frequently used functions |
 
-# Caveats
+# Caveats<a id="caveats"></a>
 - I cannot guarantee that the test suite is foolproof ATM as I'm currently the only one testing this library.
 - Library has so far only been tested with `python==3.12` and `numpy==2.4.0`
-- Library isn't tested for performance, use in production only if the primary bottleneck is brain and not hardware.
+- Library isn't tested for performance, use in production only if the primary bottleneck is brain and not hardware.
+
+# Changelog<a id="changelog"></a>
+## 0.4.2<a id="042"></a>
+- changed `ValidatedArray`, `Field` classes and `validate_array`, `validate_array_values` to accept a single validator as a parameter.
+
+## 0.4.1<a id="041"></a>
+- added cache for often used functions
+- added __str__ and __len__ methods
+
+## 0.4<a id="04"></a>
+- first version with all basic features: creating a validated array, validating dtype, shape, array and field values
+
+
+# Breaking changes<a id="breaking-changes"></a>
+- **0.4** -> **0.4.1**
+  - changed __str__ method for `Validator` to `.error_string` property (to allow different string representation for error messages and general printing)
+  - changed imports due to refactoring to simplify dependencies:
+    - `GenericErrors`
+      - from `valarray.core.errors_exceptions` -> from `valarray.core`
+    - `NumpyErrors`
+      - from `valarray.numpy.errors_exceptions` -> from `valarray.numpy`
+    - `AxisNameAndIdx`, `FieldNameAndIdx`
+      - from `valarray.core.axes_and_fields` -> from `valarray.core.data_structures`

{valarray-0.4rc1 → valarray-0.4.2}/README.md

@@ -1,8 +1,8 @@
-![](assets/images/valarray_logo.svg)
+![valarray logo](https://codeberg.org/jfranek/valarray/raw/branch/main/assets/images/valarray_logo.svg)
 
 In short, library for validating numpy arrays that also helps with static analysis and documentation. In long, see [Library rationale](#library-rationale).
 
-Currently intended primarily as a personal/hobby project (see [Caveats](#caveats))
+Currently intended primarily as a personal/hobby project (see [Caveats](#caveats)). Also not considered stable (see [Breaking changes](#breaking-changes)). 
 
 I have gotten away with using it in a professional setting, but YMMV. 
 
@@ -39,8 +39,10 @@ except ValidationException as v_exc:
 >>>         [-2.0, -6.0]
 ```
 
-# Table of contents
-- [Table of contents](#table-of-contents)
+<!-- NOTE: Headings that are used as relative links (so most of them) must have id tag defined
+(see https://github.com/pypa/readme_renderer/issues/169#issuecomment-808577486) otherwise links do not work on pypi.-->
+
+# Table of contents <!-- omit from toc -->
 - [Library rationale](#library-rationale)
   - [1) Invalid values causing unintended behaviour](#1-invalid-values-causing-unintended-behaviour)
     - [Problem](#problem)
@@ -67,13 +69,19 @@ except ValidationException as v_exc:
 - [Catching exceptions](#catching-exceptions)
   - [Special exceptions and errors](#special-exceptions-and-errors)
   - [Generic Errors](#generic-errors)
+- [Settings](#settings)
 - [Caveats](#caveats)
+- [Changelog](#changelog)
+  - [0.4.2](#042)
+  - [0.4.1](#041)
+  - [0.4](#04)
+- [Breaking changes](#breaking-changes)
 
-# Library rationale
+# Library rationale<a id="library-rationale"></a>
 This library aims to help with 3 issues encountered when working with numpy arrays:
 
-## 1) Invalid values causing unintended behaviour
-### Problem
+## 1) Invalid values causing unintended behaviour<a id="1-invalid-values-causing-unintended-behaviour"></a>
+### Problem<a id="problem"></a>
 Invalid values can cause crashes, or worse, cause silent failures.
 
 For example the following code fails silently when attempting to cut patches from image using bounding boxes with invalid coordinates.
@@ -107,7 +115,7 @@ for patch in patches:
 >>> (50, 200, 3)
 ```
 
-### Solution
+### Solution<a id="solution"></a>
 Validate boxes array first. If errors are encountered, print descriptive error message(s).
 
 ```python
@@ -161,8 +169,8 @@ except ValidationException as exc:
 >>>                 Field < 0 >: [-10]
 ```
 
-## 2) Limited support for static analysis
-### Problem
+## 2) Limited support for static analysis<a id="2-limited-support-for-static-analysis"></a>
+### Problem<a id="problem-1"></a>
 Support for static analysis is limited. Tools can only check whether the datatype is correct, but not shape, values or what those values actually represent.
 
 For example, the function to crop patches needs the boxes to be defined by `xmin, ymin, xmax, ymax` but doesn't throw an error if input boxes are defined by `x_center, y_center, width, height` and static analysis tools cannot detect this error using bulit-in numpy types.
@@ -206,7 +214,7 @@ for patch in patches_inv:
 >>> (0, 200, 3)
 ```
 
-### Solution
+### Solution<a id="solution-1"></a>
 `ValidatedNumpyArray` subclasses can represent these two types of boxes arrays, and can be used instead of bare numpy arrays in function/method signatures and such.
 ```python
     import numpy as np
@@ -273,8 +281,8 @@ for patch in patches_inv:
         print(patch.shape)
 ```
 
-## 3) Need for explicit documentation
-### Problem
+## 3) Need for explicit documentation<a id="3-need-for-explicit-documentation"></a>
+### Problem<a id="problem-2"></a>
 Using built-in numpy types provides only documentation for data types. Shape, values, constraints and what the array represents need to be explicitly documented either in comments or docstrings.
 
 If this type of array is used in multiple places / functions, this can cause duplicated documentation.
@@ -303,7 +311,7 @@ def cut_patches(
     return patches
 ```
 
-### Solution
+### Solution<a id="solution-2"></a>
 Defining data type, schema and constraints on a `ValidatedNumpyArray` subclass already implicitly documents them.
 
 This can be complemented by adding additional (or summary) documentation in the class docstring.
@@ -351,8 +359,8 @@ def cut_patches(
 ```
 
 
-# Validated Array
-## Defining a validated array
+# Validated Array<a id="validated-array"></a>
+## Defining a validated array<a id="defining-a-validated-array"></a>
 Subclass `ValidatedNumpyArray` and define:
 - `dtype` - expected data type specification (such as `float`, `"float64"`, `np.float64`).
     If not specified, data type is not validated.
@@ -361,7 +369,7 @@ Subclass `ValidatedNumpyArray` and define:
 - `schema` - expected shape specification (of type `valarray.numpy.axes_and_fields.AxesTuple`). For details, see [Array Schema](#array-schema).
         If not specified, shape is not validated (and no field validators are applied). 
 - `lt`/`le`/`ge`/`gt`/`eq` - basic array value constraints -> less (or equal) than, greater (or equal) than, equal to
-- `validators` - optional list of validators applied to the whole array. For details, see [Validators](##validators).
+- `validators` - optional validator or a tuple of validators applied to the whole array. For details, see [Validators](##validators).
 
 ```python
 import numpy as np
@@ -372,7 +380,7 @@ class ExampleValidatedNumpyArray(ValidatedNumpyArray):
   schema = ('batch_size', 3, 5)
 ```
 
-## Creating a validated array instance
+## Creating a validated array instance<a id="creating-a-validated-array-instance"></a>
 There are 4 ways to create a validated array instance:
 - validate an existing array
 ```python
@@ -415,7 +423,7 @@ v_arr = ExampleValidatedNumpyArray(np.array([1,2],dtype=np.float32), coerce_dtyp
 v_arr = ExampleValidatedNumpyArray(np.array([1,2],dtype=np.float32), coerce_dtype=True, validate=False)
 ``` 
 
-## Accessing array values
+## Accessing array values<a id="accessing-array-values"></a>
 You can access the underlying array using the `.array`/`.a_` property:
 ```python
 arr = v_arr.array
@@ -438,7 +446,7 @@ class SpecifiedDataTypeArray(ValidatedNumpyArray[np.float32]): ...
 arr = SpecifiedDataTypeArray(...).array # np.typing.NDArray[np.float32]
 ```
 
-# Validation functions
+# Validation functions<a id="validation-functions"></a>
 Array validation is designed to be modular and composable and validation functions can be used on they own if only runtime validation is required.
 Each validation function returns a list of errors, from which a `ValidationException` can be raised. For details see [Catching exceptions](#catching-exceptions).
 ```python
@@ -477,7 +485,7 @@ and a "composite" validation function:
     - *returns* `NumpyInvalidArrayValuesError`/`NumpyInvalidFieldValuesError` or no errors.
 
 
-# Array schema
+# Array schema<a id="array-schema"></a>
 Schema defines expected axes, and for each axis its' fields and optionally constraints on the field values.
 
 Axes can be defined with:
@@ -498,11 +506,11 @@ schema = (
   ("field_a", Field())
 )
 ```
-## Field
+## Field<a id="field"></a>
 Defines (optional) name and value constrints for array field. More specifically:
 - `name` - descriptive name used in error messages (if missing, field index is used instead)
 - `lt`/`le`/`ge`/`gt`/`eq` - basic array value constraints -> less (or equal) than, greater (or equal) than, equal to
-- `validators` - other validators of fields values. For details, see [Validators](##validators).
+- `validators` - optional validator or a tuple of validators applied to fields values. For details, see [Validators](##validators).
 
 ```python
 from typing import Any
@@ -517,8 +525,8 @@ f1 = Field("example_named_field", ge=0)
 f2 = Field(gt=10, validators=(ExampleNumpyValidator(),))
 ```
 
-## Array schema examples
-### rectangles
+## Array schema examples<a id="array-schema-examples"></a>
+### rectangles<a id="rectangles"></a>
 An array of arbitrary number of rectangles defined by min and max coordinates which has two axes: *n_rects* and *rect*. 
 Axis *rect* is has 4 fields: *x_min*,*y_min*,*x_max*,*y_max*, where values must be greater or equal to zero.
 
@@ -551,10 +559,10 @@ arr = np.array(
 Rect.validate(arr)
 ```
 
-# Validators
+# Validators<a id="validators"></a>
 Validators are objects that perform arbitrary validation of array or field values defined by user.
 
-## Defining a validator
+## Defining a validator<a id="defining-a-validator"></a>
 Validators must subclass `valarray.numpy.NumpyValidator` Abstract Base Class 
 and implement the `.validate()` method that takes an array as an input and results in success/failure of validation using these options:
 
@@ -567,7 +575,7 @@ and implement the `.validate()` method that takes an array as an input and resul
     - *returns* `False`
     - *raises* `ValueError`
 
-### ValidationResult
+### ValidationResult<a id="validationresult"></a>
 Contains result status of validation `status="OK"`/`status="FAIL"`
 
 Can also optionally contain:
@@ -599,7 +607,7 @@ indices = (np.array([0, 1, 1]), np.array([1, 0, 1]))
 res = ValidationResult(status="FAIL", indices_invalid=indices, msg="Optional error message.")
 ```
 
-### Example Validator
+### Example Validator<a id="example-validator"></a>
 ```python
 from dataclasses import dataclass
 from typing import Literal
@@ -636,7 +644,7 @@ class ExampleIsEvenValidator(NumpyValidator[np.uint8]):
                 return ValidationResult("FAIL", indices_invalid=~even)
 ```
 
-# Catching exceptions
+# Catching exceptions<a id="catching-exceptions"></a>
 Failed validation results in `valarray.core.errors_exceptions.ValidationException` being raised containing list of errors responsible (and name of array class if available).
 
 Main error types are:
@@ -662,21 +670,49 @@ except ValidationException as exc:
     axis_errs = exc.errs[(IncorrectAxSizesError, IncorrectAxNumberError)]
 ```
 
-## Special exceptions and errors
+## Special exceptions and errors<a id="special-exceptions-and-errors"></a>
 There are two special subclasses of `ValidationException` with associated validation errors raised during [instantiation](#creating-a-validated-array-instance):
 - `CreateArrayException` -> `CannotCreateArrayError` - Array cannot be created from supplied object.
 - `CoerceDTypeException` -> `CannotCoerceDTypeError` - If array data type cannot be coerced when creating array with `ValidatedArray(coerce_dtype=True)`
 
 
-## Generic Errors
+## Generic Errors<a id="generic-errors"></a>
 These error types have subclasses ensuring proper type hints:
 - `IncorrectDTypeError` -> `NumpyIncorrectDTypeError`
 - `CannotCoerceDTypeError` -> `NumpyCannotCoerceDTypeError`
 - `InvalidArrayValuesError` -> `NumpyInvalidArrayValuesError`
 - `InvalidFieldValuesError` -> `NumpyInvalidFieldValuesError`
 
+# Settings<a id="settings"></a>
+Global settings for the library are defined in `valarray.settings` and can be modified using environment variables.
+| ***variable name*** | ***environment variable***   | default value | description                                         |
+|---------------------|------------------------------|---------------|-----------------------------------------------------|
+| function_cache_size | VALARRAY_FUNCTION_CACHE_SIZE | 512           | cache size for (internal) frequently used functions |
 
-# Caveats
+# Caveats<a id="caveats"></a>
 - I cannot guarantee that the test suite is foolproof ATM as I'm currently the only one testing this library.
 - Library has so far only been tested with `python==3.12` and `numpy==2.4.0`
-- Library isn't tested for performance, use in production only if the primary bottleneck is brain and not hardware.
+- Library isn't tested for performance, use in production only if the primary bottleneck is brain and not hardware.
+
+# Changelog<a id="changelog"></a>
+## 0.4.2<a id="042"></a>
+- changed `ValidatedArray`, `Field` classes and `validate_array`, `validate_array_values` to accept a single validator as a parameter.
+
+## 0.4.1<a id="041"></a>
+- added cache for often used functions
+- added __str__ and __len__ methods
+
+## 0.4<a id="04"></a>
+- first version with all basic features: creating a validated array, validating dtype, shape, array and field values
+
+
+# Breaking changes<a id="breaking-changes"></a>
+- **0.4** -> **0.4.1**
+  - changed __str__ method for `Validator` to `.error_string` property (to allow different string representation for error messages and general printing)
+  - changed imports due to refactoring to simplify dependencies:
+    - `GenericErrors`
+      - from `valarray.core.errors_exceptions` -> from `valarray.core`
+    - `NumpyErrors`
+      - from `valarray.numpy.errors_exceptions` -> from `valarray.numpy`
+    - `AxisNameAndIdx`, `FieldNameAndIdx`
+      - from `valarray.core.axes_and_fields` -> from `valarray.core.data_structures`

valarray-0.4.2/docs/dependency_graphs/core.mmd

@@ -0,0 +1,30 @@
+graph TD
+    valarray.core.validators --> valarray.core.types
+    valarray.core.validators --> valarray.core.array_type_adapter
+    valarray.core.axes_and_fields --> valarray.core.validators
+    valarray.core.axes_and_fields --> valarray.core.types
+    valarray.core.errors_exceptions --> valarray.core.validators
+    valarray.core.errors_exceptions --> valarray.core.types
+    valarray.core.errors_exceptions --> valarray.core.data_structures
+    valarray.core.utils --> valarray.core.validators
+    valarray.core.utils --> valarray.core.errors_exceptions
+    valarray.core.utils --> valarray.core.axes_and_fields
+    valarray.core.utils --> valarray.core.types
+    valarray.core.utils --> valarray.core.array_type_adapter
+    valarray.core.array --> valarray.core.errors_exceptions
+    valarray.core.array --> valarray.core.axes_and_fields
+    valarray.core.array --> valarray.core.utils
+    valarray.core.array --> valarray.core.validation_functions
+    valarray.core.array --> valarray.core.validators
+    valarray.core.array --> valarray.core.array_type_adapter
+    valarray.core.array --> valarray.core.types
+    valarray.core.array_type_adapter --> valarray.core.types
+    valarray.core.validation_functions --> valarray.core.axes_and_fields
+    valarray.core.validation_functions --> valarray.core.utils
+    valarray.core.validation_functions --> valarray.core.validators
+    valarray.core.validation_functions --> valarray.core.errors_exceptions
+    valarray.core.validation_functions --> valarray.core.data_structures
+    valarray.core.validation_functions --> valarray.core.types
+    valarray.core.validation_functions --> valarray.core.array_type_adapter
+    valarray.core.data_structures
+    valarray.core.types

valarray-0.4.2/docs/dependency_graphs/core_validation_errors.mmd

@@ -0,0 +1,13 @@
+graph TD
+    valarray.core.errors_exceptions.validation_errors.values --> valarray.core.errors_exceptions.validation_errors.base
+    valarray.core.errors_exceptions.error_list --> valarray.core.errors_exceptions.validation_errors.base
+    valarray.core.errors_exceptions.error_list --> valarray.core.errors_exceptions.exceptions
+    valarray.core.errors_exceptions.validation_errors.array_creation --> valarray.core.errors_exceptions.validation_errors.base
+    valarray.core.errors_exceptions.validation_errors.dtype --> valarray.core.errors_exceptions.validation_errors.base
+    valarray.core.errors_exceptions.validation_errors.axes --> valarray.core.errors_exceptions.validation_errors.base
+    valarray.core.errors_exceptions.exceptions --> valarray.core.errors_exceptions.validation_errors.dtype
+    valarray.core.errors_exceptions.exceptions --> valarray.core.errors_exceptions.validation_errors.array_creation
+    valarray.core.errors_exceptions.exceptions --> valarray.core.errors_exceptions.validation_errors.base
+    valarray.core.errors_exceptions.exceptions --> valarray.core.errors_exceptions.error_list
+    valarray.core.errors_exceptions.validation_errors.base
+    valarray.core.errors_exceptions.validation_errors

valarray-0.4.2/docs/dependency_graphs/core_validation_functions.mmd

@@ -0,0 +1,15 @@
+graph TD
+    valarray.core.validation_functions.array_values --> valarray.core.validation_functions.utils
+    valarray.core.validation_functions.field_values.utils --> valarray.core.validation_functions.field_values.types_and_data_structures
+    valarray.core.validation_functions.field_values.utils --> valarray.core.validation_functions.utils
+    valarray.core.validation_functions.field_values.core --> valarray.core.validation_functions.field_values.utils
+    valarray.core.validation_functions.field_values.core --> valarray.core.validation_functions.field_values.types_and_data_structures
+    valarray.core.validation_functions.field_values.core --> valarray.core.validation_functions.shape
+    valarray.core.validation_functions.array --> valarray.core.validation_functions.shape
+    valarray.core.validation_functions.array --> valarray.core.validation_functions.dtype
+    valarray.core.validation_functions.array --> valarray.core.validation_functions.field_values.core
+    valarray.core.validation_functions.array --> valarray.core.validation_functions.array_values
+    valarray.core.validation_functions.field_values.types_and_data_structures
+    valarray.core.validation_functions.utils
+    valarray.core.validation_functions.shape
+    valarray.core.validation_functions.dtype

valarray-0.4.2/docs/dependency_graphs/numpy.mmd

@@ -0,0 +1,25 @@
+graph TD
+    valarray.numpy.array_type_adapter --> valarray.numpy.array_type_adapter.errors
+    valarray.numpy.array_type_adapter --> valarray.numpy.array_type_adapter.comparisons
+    valarray.numpy.array_type_adapter --> valarray.numpy.array_type_adapter.adapter
+    valarray.numpy.array_type_adapter.adapter --> valarray.numpy.types
+    valarray.numpy.array_type_adapter.adapter --> valarray.numpy.array_type_adapter.comparisons
+    valarray.numpy.array_type_adapter.adapter --> valarray.numpy.array_type_adapter.errors
+    valarray.numpy.validators --> valarray.numpy.types
+    valarray.numpy.array_type_adapter.errors --> valarray.numpy.types
+    valarray.numpy.array_type_adapter.errors --> valarray.numpy.errors_exceptions
+    valarray.numpy.array --> valarray.numpy.array_type_adapter
+    valarray.numpy.array --> valarray.numpy.types
+    valarray.numpy.array --> valarray.numpy.axes_and_fields
+    valarray.numpy.errors_exceptions --> valarray.numpy.types
+    valarray.numpy --> valarray.numpy.array_type_adapter
+    valarray.numpy --> valarray.numpy.axes_and_fields
+    valarray.numpy --> valarray.numpy.array
+    valarray.numpy --> valarray.numpy.validators
+    valarray.numpy.validation_functions --> valarray.numpy.array_type_adapter
+    valarray.numpy.validation_functions --> valarray.numpy.types
+    valarray.numpy.validation_functions --> valarray.numpy.validators
+    valarray.numpy.validation_functions --> valarray.numpy.axes_and_fields
+    valarray.numpy.axes_and_fields --> valarray.numpy.types
+    valarray.numpy.array_type_adapter.comparisons --> valarray.numpy.types
+    valarray.numpy.types

{valarray-0.4rc1 → valarray-0.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "valarray"
-version = "0.4rc1"
+version = "0.4.2"
 authors = [
   { name="J. Franek", email="franek.j27@email.cz" },
 ]

{valarray-0.4rc1 → valarray-0.4.2}/requirements_dev.txt

@@ -2,4 +2,5 @@ setuptools
 pytest
 pytest-cov
 build
-twine
+twine
+dotenv

valarray-0.4.2/requirements_dev_optional.txt

@@ -0,0 +1 @@
+tach #creating dependency graphs