# pynrw
[](https://results.pre-commit.ci/latest/github/realshouzy/pynrw/main)
[](https://github.com/realshouzy/pynrw/actions/workflows/pylint.yaml)
[](https://github.com/realshouzy/pynrw/actions/workflows/test.yaml)
[](https://github.com/realshouzy/pynrw/actions/workflows/codeql.yaml)
[](https://github.com/realshouzy/pynrw/releases/latest)
[](https://pypi.org/project/pynrw/)
[](https://github.com/realshouzy/pynrw/releases)
[](https://pypi.org/project/pynrw/)
[](https://github.com/realshouzy/pynrw/blob/main/LICENSE)
[](https://github.com/astral-sh/ruff)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
This package implements the datastructures, database and network classes given by the German state NRW in Python, thus futher documentation will be in German. This code is purely intended for educational purposes and should not be used in production!
**Dieses Package dient alleine zu Bildungszwecken und sollte nicht in Produktion genutzt werden!**
## Installation
```bash
pip install pynrw
```
Alternativ:
```bash
pip install git+https://github.com/realshouzy/pynrw
```
## Beispiel
```python
from nrw.algorithms import quick_sort
from nrw.datastructures import List
lst: List[int] = List()
for i in range(0, 10, -1):
lst.append(i)
print(lst.content) # None
lst.to_first()
print(lst.content) # 9
print(lst) # List(9 -> 8 -> 7 -> 6 -> 5 -> 4 -> 3 -> 2 -> 1 -> 0)
sorted_lst: List[int] = quick_sort(lst)
sorted_lst.to_first()
print(sorted_lst.content) # 0
print(sorted_lst) # List(0 -> 1 -> 2 -> 3 -> 4 -> 5 -> 6 -> 7 -> 8 -> 9)
```
## Dokumentation
### Datenstrukturen
Dieses Package implementiert die Datenstrukturen nach den Vorgaben des Landes NRW in Python, zu finden in [`nrw.datastructures`](/nrw/datastructures/), d.s.:
- [`List`](/nrw/datastructures/_list.py)
- [`Stack`](/nrw/datastructures/_stack.py)
- [`Queue`](/nrw/datastructures/_queue.py)
- [`BinaryTree`](/nrw/datastructures/_binary_tree.py)
- [`BinarySearchTree`](/nrw/datastructures/_binary_search_tree.py)
- [`Vertex`](/nrw/datastructures/_vertex.py)
- [`Edge`](/nrw/datastructures/_edge.py)
- [`Graph`](/nrw/datastructures/_graph.py)
Die Implementation ist semantisch identisch zu der Implementation des Landes mit dem einzigen Unterschied, dass alles mehr *pythonic* ist, d. h. die Benennung der Methoden folgt [`pep8`](https://peps.python.org/pep-0008/), `Getter` und `Setter` sind, wo es sinnvoll ist, in [`properties`](https://docs.python.org/3/library/functions.html#property) transformiert und die Dokumentation (*doc strings*) sind ebenfalls angepasst worden.
Das Interface `ComparableContent` ist ein gleichnamiges [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol), definiert in [`nrw.datastructures._comparable_content`](/nrw/datastructures/_comparable_content.py). Es gibt die [*dunder special methods*](https://docs.python.org/3/reference/datamodel.html#object.__lt__), `__eq__`, `__lt__` und `__gt__` für einfache Vergleichsoperationen vor. Das Module stellt auch ein [`TypeVar`](https://docs.python.org/3/library/typing.html#typing.TypeVar) `ComparableContentT` zur Verfügung.
Außerdem implementieren die Datenstrukturen `__str__`, welches das Arbeiten mit diesen deutlich vereinfacht (besonders für `Binary(Search)Tree`) und `__repr__`, welches eine grobe Idee der internen Strukture gibt, z.B.:
```python
from nrw.datastructures import BinarySearchTree
bst: BinarySearchTree[int] = BinarySearchTree()
bst.insert(3)
bst.insert(2)
bst.insert(5)
bst.insert(0)
bst.insert(1)
bst.insert(4)
print(bst)
# 3__
# / \
# __2 5
# / /
# 0 4
# \
# 1
```
Des weiteren sind (triviale) Optimierungen vorgenommen worden:
- Verwendung von [`__slots__`](https://docs.python.org/3/reference/datamodel.html#slots)
- redundante Aufrufe werden weggelassen
- interne Optimierungen bei Zuweisungen
### Algorithmen
Zusätzlich enthält dieses Package nützliche Funktionen zum Sortieren, Suchen und Traversiern, zu finden in [`nrw.algorithms`](/nrw/algorithms/):
- [`linear_search`](/nrw/algorithms/_searching.py#L23)
- [`depth_first_search`](/nrw/algorithms/_searching.py#L55)
- [`breadth_first_search`](/nrw/algorithms/_searching.py#L64)
- [`bubble_sort`](/nrw/algorithms/_sorting.py#L21)
- [`selection_sort`](/nrw/algorithms/_sorting.py#L37)
- [`insertion_sort`](/nrw/algorithms/_sorting.py#L67)
- [`merge_sort`](/nrw/algorithms/_sorting.py#L86)
- [`quick_sort`](/nrw/algorithms/_sorting.py#L141)
- [`preorder`](/nrw/algorithms/_traversal.py#L19)
- [`inorder`](/nrw/algorithms/_traversal.py#L41)
- [`postorder`](/nrw/algorithms/_traversal.py#L63)
- [`levelorder`](/nrw/algorithms/_traversal.py#L85)
Die verschiedenen Traversierungen unterstützen auch Umkehrung.
Allerdings muss annotiert werden, dass aufgrund der Vorgaben des Landes die Laufzeiten nicht optimal sind. Zudem kann es zu ungewollten Nebeneffekte kommen. Welche dies sind, wird dem Leser als Übung überlassen.
### Datenbankklassen
Analog zu den Datenstrukturen sind auch Datenbankklassen größtenteils semantisch identisch zur den Vorgaben des Landes.
Die jeweiligen Klassen sind in [`nrw.database`](/nrw/database/) definiert:
- [`sqlite.DatabaseConnector`](/nrw/database/sqlite.py)
- [`mysql.DatabaseConnector`](/nrw/database/mysql.py)
- [`msaccess.DatabaseConnector`](/nrw/database/msaccess.py)
- [`QueryResult`](/nrw/database/_query_result.py)
Hierbei ist zu beachten, dass der `DatabaseConnector` für MSAccess den Microsoft Access Driver benötigt und passwortgeschützte Datenbanken nicht unterstüzt.
Des weiteren gilt für `QueryResult`, dass die Daten und die Spaltentypen nicht unbedingt als String wiedergegeben werden. Die Daten werden als Python-Äquivalenten Datentypen wiedergegeben, und für die Spaltentypen gilt:
- SQLite: immer `None`, da SQLite dynamisch typisiert ist
- 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, v.a. der Quellcode des Servers. Nichtsdestotrotz ist die Anwendung und der Funktionsumfang der Selbe wie vom Land.
### Allgemein
Mir ist bewusst, dass manche Klassen wie `QueryResult` oder auch die Nodes sich besser als `dataclasses` eignen. Allerdings können die Docstrings so nicht für alle Methoden und Properties gesetzt werden.
Für mehr Information zu einem beliebigen Objekt kann `help` genutzt werden, z.B.:
```python
from nrw.datastructures import List
help(List)
help(List.insert)
```
**Es soll nicht vor einem Blick in den Quellcode zurückgeschreckt werden.**
## Motivation
Vereinfacht: Java, als Programmiersprache in der Bildung, ist eine schlechte Wahl, da ...
- Java veraltet ist.
- das rein objekt-orientierte Paradigma schlechthin unbrauchbar ist.
- die Syntax und und die statische Typisierung für Anfänger einschränkend sein können.
Diese Probleme und Hürden werden größtenteils mit Python überwunden.
## Unterstützung
Jegliche Form der Unterstützung ist willkommen. Für mehr Informationen referiere ich [hierhin](/CONTRIBUTING.md).
## Quellen
- [Materialien zu den zentralen Abiturprüfungen im Fach Informatik](https://www.schulentwicklung.nrw.de/lehrplaene/upload/klp_SII/if/Dokumentation_ZA-IF_GK-LK_ab_2018_2021_12_22.pdf)
- [Python Dokumentation](https://docs.python.org/3/)
- [SIBI](https://sibiwiki.de/wiki/index.php?title=Kategorie:Informatik)
Raw data
{
"_id": null,
"home_page": null,
"name": "pynrw",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "nrw, datastructures, datenstrukturen, algorithms, algorithmen, education, bildung, abitur",
"author": "realshouzy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d2/26/d6495d65fef63aecd19714c40c55809687ba3752c8e988130185345415d3/pynrw-1.5.2.tar.gz",
"platform": "any",
"description": "# pynrw\n\n[](https://results.pre-commit.ci/latest/github/realshouzy/pynrw/main)\n[](https://github.com/realshouzy/pynrw/actions/workflows/pylint.yaml)\n[](https://github.com/realshouzy/pynrw/actions/workflows/test.yaml)\n[](https://github.com/realshouzy/pynrw/actions/workflows/codeql.yaml)\n[](https://github.com/realshouzy/pynrw/releases/latest)\n[](https://pypi.org/project/pynrw/)\n[](https://github.com/realshouzy/pynrw/releases)\n[](https://pypi.org/project/pynrw/)\n[](https://github.com/realshouzy/pynrw/blob/main/LICENSE)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n\nThis package implements the datastructures, database and network classes given by the German state NRW in Python, thus futher documentation will be in German. This code is purely intended for educational purposes and should not be used in production!\n\n**Dieses Package dient alleine zu Bildungszwecken und sollte nicht in Produktion genutzt werden!**\n\n## Installation\n\n```bash\npip install pynrw\n```\n\nAlternativ:\n\n```bash\npip install git+https://github.com/realshouzy/pynrw\n```\n\n## Beispiel\n\n```python\nfrom nrw.algorithms import quick_sort\nfrom nrw.datastructures import List\n\nlst: List[int] = List()\n\nfor i in range(0, 10, -1):\n lst.append(i)\n\nprint(lst.content) # None\nlst.to_first()\nprint(lst.content) # 9\nprint(lst) # List(9 -> 8 -> 7 -> 6 -> 5 -> 4 -> 3 -> 2 -> 1 -> 0)\n\nsorted_lst: List[int] = quick_sort(lst)\nsorted_lst.to_first()\nprint(sorted_lst.content) # 0\nprint(sorted_lst) # List(0 -> 1 -> 2 -> 3 -> 4 -> 5 -> 6 -> 7 -> 8 -> 9)\n```\n\n## Dokumentation\n\n### Datenstrukturen\n\nDieses Package implementiert die Datenstrukturen nach den Vorgaben des Landes NRW in Python, zu finden in [`nrw.datastructures`](/nrw/datastructures/), d.s.:\n\n- [`List`](/nrw/datastructures/_list.py)\n- [`Stack`](/nrw/datastructures/_stack.py)\n- [`Queue`](/nrw/datastructures/_queue.py)\n- [`BinaryTree`](/nrw/datastructures/_binary_tree.py)\n- [`BinarySearchTree`](/nrw/datastructures/_binary_search_tree.py)\n- [`Vertex`](/nrw/datastructures/_vertex.py)\n- [`Edge`](/nrw/datastructures/_edge.py)\n- [`Graph`](/nrw/datastructures/_graph.py)\n\nDie Implementation ist semantisch identisch zu der Implementation des Landes mit dem einzigen Unterschied, dass alles mehr *pythonic* ist, d. h. die Benennung der Methoden folgt [`pep8`](https://peps.python.org/pep-0008/), `Getter` und `Setter` sind, wo es sinnvoll ist, in [`properties`](https://docs.python.org/3/library/functions.html#property) transformiert und die Dokumentation (*doc strings*) sind ebenfalls angepasst worden.\n\nDas Interface `ComparableContent` ist ein gleichnamiges [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol), definiert in [`nrw.datastructures._comparable_content`](/nrw/datastructures/_comparable_content.py). Es gibt die [*dunder special methods*](https://docs.python.org/3/reference/datamodel.html#object.__lt__), `__eq__`, `__lt__` und `__gt__` f\u00fcr einfache Vergleichsoperationen vor. Das Module stellt auch ein [`TypeVar`](https://docs.python.org/3/library/typing.html#typing.TypeVar) `ComparableContentT` zur Verf\u00fcgung.\n\nAu\u00dferdem implementieren die Datenstrukturen `__str__`, welches das Arbeiten mit diesen deutlich vereinfacht (besonders f\u00fcr `Binary(Search)Tree`) und `__repr__`, welches eine grobe Idee der internen Strukture gibt, z.B.:\n\n```python\nfrom nrw.datastructures import BinarySearchTree\n\nbst: BinarySearchTree[int] = BinarySearchTree()\nbst.insert(3)\nbst.insert(2)\nbst.insert(5)\nbst.insert(0)\nbst.insert(1)\nbst.insert(4)\nprint(bst)\n# 3__\n# / \\\n# __2 5\n# / /\n# 0 4\n# \\\n# 1\n```\n\nDes weiteren sind (triviale) Optimierungen vorgenommen worden:\n\n- Verwendung von [`__slots__`](https://docs.python.org/3/reference/datamodel.html#slots)\n- redundante Aufrufe werden weggelassen\n- interne Optimierungen bei Zuweisungen\n\n### Algorithmen\n\nZus\u00e4tzlich enth\u00e4lt dieses Package n\u00fctzliche Funktionen zum Sortieren, Suchen und Traversiern, zu finden in [`nrw.algorithms`](/nrw/algorithms/):\n\n- [`linear_search`](/nrw/algorithms/_searching.py#L23)\n- [`depth_first_search`](/nrw/algorithms/_searching.py#L55)\n- [`breadth_first_search`](/nrw/algorithms/_searching.py#L64)\n- [`bubble_sort`](/nrw/algorithms/_sorting.py#L21)\n- [`selection_sort`](/nrw/algorithms/_sorting.py#L37)\n- [`insertion_sort`](/nrw/algorithms/_sorting.py#L67)\n- [`merge_sort`](/nrw/algorithms/_sorting.py#L86)\n- [`quick_sort`](/nrw/algorithms/_sorting.py#L141)\n- [`preorder`](/nrw/algorithms/_traversal.py#L19)\n- [`inorder`](/nrw/algorithms/_traversal.py#L41)\n- [`postorder`](/nrw/algorithms/_traversal.py#L63)\n- [`levelorder`](/nrw/algorithms/_traversal.py#L85)\n\nDie verschiedenen Traversierungen unterst\u00fctzen auch Umkehrung.\nAllerdings muss annotiert werden, dass aufgrund der Vorgaben des Landes die Laufzeiten nicht optimal sind. Zudem kann es zu ungewollten Nebeneffekte kommen. Welche dies sind, wird dem Leser als \u00dcbung \u00fcberlassen.\n\n### Datenbankklassen\n\nAnalog zu den Datenstrukturen sind auch Datenbankklassen gr\u00f6\u00dftenteils semantisch identisch zur den Vorgaben des Landes.\nDie jeweiligen Klassen sind in [`nrw.database`](/nrw/database/) definiert:\n\n- [`sqlite.DatabaseConnector`](/nrw/database/sqlite.py)\n- [`mysql.DatabaseConnector`](/nrw/database/mysql.py)\n- [`msaccess.DatabaseConnector`](/nrw/database/msaccess.py)\n- [`QueryResult`](/nrw/database/_query_result.py)\n\nHierbei ist zu beachten, dass der `DatabaseConnector` f\u00fcr MSAccess den Microsoft Access Driver ben\u00f6tigt und passwortgesch\u00fctzte Datenbanken nicht unterst\u00fczt.\nDes weiteren gilt f\u00fcr `QueryResult`, dass die Daten und die Spaltentypen nicht unbedingt als String wiedergegeben werden. Die Daten werden als Python-\u00c4quivalenten Datentypen wiedergegeben, und f\u00fcr die Spaltentypen gilt:\n\n- SQLite: immer `None`, da SQLite dynamisch typisiert ist\n- MySQL: die entsprechenden Datentypen von MySQL als String\n- MSAccess: die entsprechenden Datentypen (Klassen) von Python\n\n### Netzklassen\n\nDie Netzklassen sind ebenfalls semantisch identisch zu den Netzklassen des Landes. Diese sind in [`nrw.network`](/nrw/network/) zu definiert:\n\n- [`Connection`](/nrw/network/_connection.py)\n- [`Client`](/nrw/network/_client.py)\n- [`Server`](/nrw/network/_server.py)\n\nDie 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 \u00fcbertragen werden kann; somit ist der Quellcode f\u00fcr Fortgeschrittene, v.a. der Quellcode des Servers. Nichtsdestotrotz ist die Anwendung und der Funktionsumfang der Selbe wie vom Land.\n\n### Allgemein\n\nMir ist bewusst, dass manche Klassen wie `QueryResult` oder auch die Nodes sich besser als `dataclasses` eignen. Allerdings k\u00f6nnen die Docstrings so nicht f\u00fcr alle Methoden und Properties gesetzt werden.\n\nF\u00fcr mehr Information zu einem beliebigen Objekt kann `help` genutzt werden, z.B.:\n\n```python\nfrom nrw.datastructures import List\nhelp(List)\nhelp(List.insert)\n```\n\n**Es soll nicht vor einem Blick in den Quellcode zur\u00fcckgeschreckt werden.**\n\n## Motivation\n\nVereinfacht: Java, als Programmiersprache in der Bildung, ist eine schlechte Wahl, da ...\n\n- Java veraltet ist.\n- das rein objekt-orientierte Paradigma schlechthin unbrauchbar ist.\n- die Syntax und und die statische Typisierung f\u00fcr Anf\u00e4nger einschr\u00e4nkend sein k\u00f6nnen.\n\nDiese Probleme und H\u00fcrden werden gr\u00f6\u00dftenteils mit Python \u00fcberwunden.\n\n## Unterst\u00fctzung\n\nJegliche Form der Unterst\u00fctzung ist willkommen. F\u00fcr mehr Informationen referiere ich [hierhin](/CONTRIBUTING.md).\n\n## Quellen\n\n- [Materialien zu den zentralen Abiturpr\u00fcfungen im Fach Informatik](https://www.schulentwicklung.nrw.de/lehrplaene/upload/klp_SII/if/Dokumentation_ZA-IF_GK-LK_ab_2018_2021_12_22.pdf)\n- [Python Dokumentation](https://docs.python.org/3/)\n- [SIBI](https://sibiwiki.de/wiki/index.php?title=Kategorie:Informatik)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Materialien zu den zentralen NRW-Abiturpr\u00fcfungen im Fach Informatik ab 2018 implementiert in Python.",
"version": "1.5.2",
"project_urls": {
"Source": "https://github.com/realshouzy/pynrw"
},
"split_keywords": [
"nrw",
" datastructures",
" datenstrukturen",
" algorithms",
" algorithmen",
" education",
" bildung",
" abitur"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73bbf161859ca498e520cbcd9134000f0f0fde12f89543a365ec6602356ff5bc",
"md5": "ac51f362b2e28f21112d88d72ccbd2c7",
"sha256": "7d46bb6f26aee23b23558c4b884c503027a1a10d3b1282d5edb4b1e9a2667dae"
},
"downloads": -1,
"filename": "pynrw-1.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac51f362b2e28f21112d88d72ccbd2c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6146,
"upload_time": "2024-06-11T00:50:46",
"upload_time_iso_8601": "2024-06-11T00:50:46.135975Z",
"url": "https://files.pythonhosted.org/packages/73/bb/f161859ca498e520cbcd9134000f0f0fde12f89543a365ec6602356ff5bc/pynrw-1.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d226d6495d65fef63aecd19714c40c55809687ba3752c8e988130185345415d3",
"md5": "ea881dee1084be1dac42da4fae87a382",
"sha256": "58426ea41563f37d774296a4a621646b77cfff3bf91327bc19519a321a10cd8b"
},
"downloads": -1,
"filename": "pynrw-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "ea881dee1084be1dac42da4fae87a382",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6858,
"upload_time": "2024-06-11T00:50:47",
"upload_time_iso_8601": "2024-06-11T00:50:47.761436Z",
"url": "https://files.pythonhosted.org/packages/d2/26/d6495d65fef63aecd19714c40c55809687ba3752c8e988130185345415d3/pynrw-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 00:50:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "realshouzy",
"github_project": "pynrw",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pynrw"
}
JSON
