Skip to content

Commit

Permalink
🔧 Add blacken-docs
Browse files Browse the repository at this point in the history
* Fix Python syntax
  • Loading branch information
veit committed Oct 1, 2024
1 parent 29b61a4 commit 50d2104
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 14 deletions.
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ repos:
rev: 24.8.0
hooks:
- id: black
- repo: https://github.com/adamchainz/blacken-docs
rev: "1.18.0"
hooks:
- id: blacken-docs
args: [--line-length=79]
additional_dependencies:
- black
- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
Expand Down
2 changes: 1 addition & 1 deletion docs/data-processing/apis/fastapi/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ zu erhalten:
@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
return {"item_name": item.name, "item_id": item_id}
return {"item_name": item.name, "item_id": item_id}
Der Server lädt die Datei automatisch neu, da wir den
`uvicorn <http://www.uvicorn.org/>`_-Aufruf in Schritt 2 mit der Option
Expand Down
4 changes: 4 additions & 0 deletions docs/data-processing/postgresql/db-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Connection

Beispiel:

.. blacken-docs:off
.. code-block:: python
import driver
Expand All @@ -44,6 +46,8 @@ Connection
conn.commit()
conn.close()
.. blacken-docs:on
Cursor
`Cursorobjekte <https://peps.python.org/pep-0249/#cursor-objects>`_ werden
zum Verwalten des Kontexts einer ``.fetch*()``-Methode verwendet.
Expand Down
12 changes: 6 additions & 6 deletions docs/data-processing/postgresql/ipython-sql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,29 @@ Erste Schritte

#. Zunächst wird ipython-sql in eurem Notebook aktiviert mit

.. code-block:: python
.. code-block:: ipython
In [1]: %load_ext sql
#. Für die Verbindung zur Datenbank wird die `SQLAlchemy URL
<https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls>`_
verwendet:

.. code-block:: python
.. code-block:: ipython
In [2]: %sql postgresql://
#. Anschließend könnt ihr eine Tabelle erstellen, :abbr:`z.B. (zum Beispiel)`:

.. code-block:: python
.. code-block:: ipython
In [3]: %%sql postgresql://
....: CREATE TABLE accounts (login, name, email)
....: INSERT INTO accounts VALUES ('veit', 'Veit Schiele', [email protected]);
#. Die Inhalte der Tabelle ``accounts`` könnt ihr abfragen mit

.. code-block:: python
.. code-block:: ipython
In [4]: result = %sql select * from accounts
Expand All @@ -62,7 +62,7 @@ Begrenzung, mit ``Autolimit`` lässt sich jedoch die Ergebnismenge limitieren.
Mit ``%config SqlMagic`` könnt ihr Euch die aktuelle Konfiguration ausgeben
lassen:

.. code-block:: python
.. code-block:: ipython
In [5]: %config SqlMagic
SqlMagic options
Expand All @@ -89,7 +89,7 @@ pandas

Wenn pandas installiert ist, kann die ``DataFrame``-Methode verwendet werden:

.. code-block:: python
.. code-block:: ipython
In [6]: result = %sql SELECT * FROM accounts
Expand Down
5 changes: 1 addition & 4 deletions docs/data-processing/postgresql/sqlalchemy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,7 @@ Create Session
address = Address(street="Birnbaumweg 10", zipcode="79115", country="Germany")
contact = Contact(
firstname="Veit",
lastname="Schiele",
email="[email protected]",
address=address
firstname="Veit", lastname="Schiele", email="[email protected]", address=address
)
session.add(contact)
Expand Down
4 changes: 4 additions & 0 deletions docs/productive/git/advanced/bisect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,8 @@ komplizierteren Verhaltensänderungen suchen. Für Performance-Tests benötigen
hierfür ein Testprogramm, das mehrere Durchläufe durchführen und die minimale
Zeit ermitteln kann, wobei mögliches Rauschen eliminiert werden soll:

.. blacken-docs:off
.. code-block:: python
from subprocess import run
Expand All @@ -167,6 +169,8 @@ Zeit ermitteln kann, wobei mögliches Rauschen eliminiert werden soll:
print("Fast enough")
raise SystemExit(0)
.. blacken-docs:on
Das Programm führt :samp:`python perftest.py {PARAM}` zehnmal aus und misst bei
jeder Ausführung die Zeit. Anschließend vergleicht es die minimale
Ausführungszeit mit einem Grenzwert von ``X`` Sekunden. Liegt die Mindestzeit
Expand Down
7 changes: 4 additions & 3 deletions docs/productive/qa/code-smells.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,16 @@ Eigenschaft:
class Image(object):
thumbnail_resolution = 128
def __init__(self, path):
...
"..."
def crop(self, width, height):
...
"..."
@property
def thumbnail(self):
...
"..."
return thumb
Objekte, die Funktionen sein sollten
Expand Down
4 changes: 4 additions & 0 deletions docs/workspace/ipython/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ IPython-Erweiterungen schreiben
Eine IPython-Erweiterung ist ein importierbares Python-Modul, das über spezielle
Funktionen zum Laden und Entladen verfügt:

.. blacken-docs:off
.. code-block:: python
def load_ipython_extension(ipython):
Expand All @@ -56,5 +58,7 @@ Funktionen zum Laden und Entladen verfügt:
def unload_ipython_extension(ipython):
# If you want your extension to be unloadable, put that logic here.
.. blacken-docs:on
.. seealso::
* :label:`defining_magics`

0 comments on commit 50d2104

Please sign in to comment.