diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ef5243..4a9d35e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,6 +72,15 @@ To only run a specific test run: pytest -k test_name_of_the_test ``` +##### Annotation + +Note that the tests for the network classes may be unstable, because of threading. Therefore they are omitted from `tox` and the [`Test`](/.github/workflows/test.yaml) workflow using `pytest` markers. +To do the same when running `pytest` directly, run: + +```bash +pytest -m "not networktest" +``` + #### Code linting The linting and formatting is done using ``pre-commit``, thus run: diff --git a/README.md b/README.md index 3d7280b..6a0adfa 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,16 @@ Des weiteren gilt für `QueryResult`, dass die Daten und die Spaltentypen nicht - MySQL: die entsprechenden Datentypen von MySQL als String - MSAccess: die entsprechenden Datentypen (Klassen) von Python +### Netzklassen + +Die Netzklassen sind ebenfalls semantisch identisch zu den Netzklassen des Landes. Diese sind in [`nrw.network`](/nrw/network/) zu definiert: + +- [`Connection`](/nrw/network/_connection.py) +- [`Client`](/nrw/network/_client.py) +- [`Server`](/nrw/network/_server.py) + +Die letzteren beiden sind [`ABCs`](https://docs.python.org/3/library/abc.html). Bei diesen weicht die interne Implementation von der Java Implementation des Landes ab, da deren Ansatz nicht eins-zu-eins in Python übertragen werden kann; somit ist der Quellcode für Fortgeschrittene. Nichtsdestotrotz ist die Anwendung und der Funktionsumfang der Selbe wie vom Land. + ### Allgemein Für mehr Information zu einem beliebigen Objekt kann `help` genutzt werden, z.B.: