WhosWhoPy - Revision history

Timb at 21:40, 13 March 2019

2019-03-13T21:40:52Z

Timb: /* Aan de slag met Python */

2019-03-06T14:58:10Z

‎Aan de slag met Python

Timb: Leg uit hoe requests werken

2019-03-06T14:55:42Z

Leg uit hoe requests werken

Timb: Licht overige WhosWhoPy-onderdelen toe

2019-03-06T14:44:37Z

Licht overige WhosWhoPy-onderdelen toe

Timb: Created page with "'''WhosWhoPy''' is bedoeld als equivalent van WhosWho4, maar dan in Python. Het is oorspronkelijk gebouwd voor databasemigraties. == Aan de slag met..."

2018-06-03T14:31:08Z

Created page with "'''WhosWhoPy''' is bedoeld als equivalent van WhosWho4, maar dan in Python. Het is oorspronkelijk gebouwd voor databasemigraties. == Aan de slag met..."

New page

'''WhosWhoPy''' is bedoeld als equivalent van [[WhosWho4]], maar dan in Python. Het is oorspronkelijk gebouwd voor [[WebCie Databases|databasemigraties]].

== Aan de slag met Python ==

WhosWhoPy vereist een redelijk recente editie van Python 3 en pip. Als je <code>[[manage]] build</code> uitvoert, worden de rest van de benodigdheden geïnstalleerd in een [https://virtualenv.pypa.io/en/stable/ virtuele omgeving]. Het idee van deze virtuele omgeving is dat we hierin al onze dependencies installeren zonder dat dit systeembreed is of conflicten geeft met projecten met andere dependencies. Het volgende is dus '''belangrijk''': voordat je een python-commando uitvoert, run <code>source venv/bin/activate</code> in de [[debugrootdir]]. (Alle pythoncommando's gaan ervan uit dat dit gebeurd is, en je in de debugrootdir zit.)

== Architectuur ==

WhosWhoPy heeft als kern een hoop modelklassen (de (klein)kindklassen van <code>Entiteit</code>) die gegenereerd worden op basis van een klassediagram. Daarnaast hebben we wat hulpfuncties om de klassen op elkaar te laten werken, en een paar scripts die die hulpfuncties aanroepen. Specifiekere onderdelen worden hieronder toegelicht.

=== whoswhopy.config ===

Module om configuratiewaarden uit te lezen. Bij het importeren van deze module worden de configuratiewaarden ingelezen. Er zijn generieke functies <code>geef</code> en <code>geef_verplicht</code> voor stringvormige configuratiewaarden, en waardespecifieke functies zoals <code>debug</code> die waarden parsen en andere types geven (zoals hier een bool).

=== whoswhopy.database ===

Module om databaseverbinding te maken. Bij het importeren wordt deze verbinding gemaakt en in de variabele <code>wsw4db</code> (van type [http://docs.sqlalchemy.org/en/latest/orm/session_api.html#sqlalchemy.orm.session.Session sqlalchemy.Session]) gezet.

=== whoswhopy.gen ===

Bevat de gegenereerde code van <code>dia2py</code>, zie verderop.

== Codestijl ==

We houden de canonieke stijl van [https://www.python.org/dev/peps/pep-0008/ PEP-8] aan, dus indentatie is 4 spaties en geen alignment alsjeblieft dankjewel.

== Programmeertools ==

Voor codekwaliteit hebben we ook wat tools:

* [https://docs.pytest.org pytest] en [hypothesis https://virtualenv.pypa.io/en/stable/]: een fijn unittestframework en volautomatische testcasegeneratie. Je kan <code>pytest</code> aanroepen in de debugrootdir om tests te runnen.
* [https://www.pylint.org/ pylint] om je te wijzen op code smells/lelijke codestijl (moet misschien nog een beetje getweakt worden).

== Generated code ==

Zie ook: [[Dia en generated code]].

Het script <code>dia2py</code> zet een gegeven klassediagram, in de vorm van een <code>.dia</code>-bestand, om in Pythonklassen. Je kan de resulterende klassen importeren als <code>from whoswhopy.gen.Bla import Bla</code> (of <code>from whoswhopy.gen.Intro.Bla import Bla</code> als de code in een package zit). Deze klassen zijn [http://docs.sqlalchemy.org/en/latest/orm/tutorial.html SQLAlchemy ORM]-gebaseerde klassen, en je kan ermee werken zoals je van SQLAlchemy gewend bent.

Mocht je alle klassen willen gebruiken, dan kun je doen <code>import whoswhopy.gen.alles as alles</code>. Deze functionaliteit is bijvoorbeeld nodig om alle klassen aan de migratiegenerator door te geven.

[[Category:WebCie]]

← Older revision		Revision as of 21:40, 13 March 2019
Line 67:		Line 67:

	Mocht je alle klassen willen gebruiken, dan kun je doen <code>import whoswhopy.gen.alles as alles</code>. Deze functionaliteit is bijvoorbeeld nodig om alle klassen aan de migratiegenerator door te geven.		Mocht je alle klassen willen gebruiken, dan kun je doen <code>import whoswhopy.gen.alles as alles</code>. Deze functionaliteit is bijvoorbeeld nodig om alle klassen aan de migratiegenerator door te geven.
		+
		+	== Reloaden na wijzigingen ==
		+
		+	Apache herstart de daemon, en past dus eventuele wijzigingen toe, zodra je de modificatietijd van <code>whoswhopy.wsgi</code> aanpast. Oftewel je kan je wijzigingen op je debug toepassen door te doen: <code>touch whoswhopy.wsgi</code>. Zie ook https://modwsgi.readthedocs.io/en/develop/user-guides/reloading-source-code.html

	[[Category:WebCie]]		[[Category:WebCie]]

← Older revision		Revision as of 14:58, 6 March 2019
Line 4:		Line 4:

	WhosWhoPy vereist een redelijk recente editie van Python 3 en pip. Als je <code>[[manage]] build</code> uitvoert, worden de rest van de benodigdheden geïnstalleerd in een [https://virtualenv.pypa.io/en/stable/ virtuele omgeving]. Het idee van deze virtuele omgeving is dat we hierin al onze dependencies installeren zonder dat dit systeembreed is of conflicten geeft met projecten met andere dependencies. Het volgende is dus '''belangrijk''': voordat je een python-commando uitvoert, run <code>source venv/bin/activate</code> in de [[debugrootdir]]. (Alle pythoncommando's gaan ervan uit dat dit gebeurd is, en je in de debugrootdir zit.)		WhosWhoPy vereist een redelijk recente editie van Python 3 en pip. Als je <code>[[manage]] build</code> uitvoert, worden de rest van de benodigdheden geïnstalleerd in een [https://virtualenv.pypa.io/en/stable/ virtuele omgeving]. Het idee van deze virtuele omgeving is dat we hierin al onze dependencies installeren zonder dat dit systeembreed is of conflicten geeft met projecten met andere dependencies. Het volgende is dus '''belangrijk''': voordat je een python-commando uitvoert, run <code>source venv/bin/activate</code> in de [[debugrootdir]]. (Alle pythoncommando's gaan ervan uit dat dit gebeurd is, en je in de debugrootdir zit.)
		+
		+	Zie ook [[WhosWhoPy op een webcie-vm]].

	== Architectuur ==		== Architectuur ==

← Older revision		Revision as of 14:55, 6 March 2019
Line 34:		Line 34:

	Verscheidene modules om integratie met PHP in het algemeen, en Space/WhosWho4 in het bijzonder, mogelijk te maken. Aan de basis ligt <code>whoswhopy.php.vreemde_functie</code>, die een wrapper geeft om PHP-functies, zodat ze vanuit Python aangeroepen kunnen worden.		Verscheidene modules om integratie met PHP in het algemeen, en Space/WhosWho4 in het bijzonder, mogelijk te maken. Aan de basis ligt <code>whoswhopy.php.vreemde_functie</code>, die een wrapper geeft om PHP-functies, zodat ze vanuit Python aangeroepen kunnen worden.
		+
		+	== Hoe requests werken ==
		+
		+	Als een request naar WhosWhoPy binnenkomt in Apache, gebeuren er een paar dingen.
		+
		+	Ten eerste geeft Apache door middel van [http://flask.pocoo.org/docs/1.0/deploying/mod_wsgi/ mod_wsgi] de request door aan de Flask-applicatie. Flask zorgt voor routing, die je bijvoorbeeld ziet als <code>@app.route('/dingweb/een/of/ander/bestand')</code> in <code>whoswhopy.app</code>. In het normale geval komt de route uit bij een Pythonfunctie die gewoon werkt als een normale Flask-endpoint. Misschien is er nog iets nodig als een databaseverbinding, wat we doen door middel van een decorator die de <code>WhosWhoPy</code>-klasse ondersteunt.
		+
		+	In een iets ingewikkelder geval, moeten we gebruik maken van oude PHP-code om de request af te handelen. Dit is qua programmeren niet veel anders dan een normale request, alleen wordt er een <code>whoswhopy.php.vreemde_functie.VreemdeFunctie</code> aangeroepen, en daarvoor dus snel een PHP-proces opgestart om de functie af te handelen.
		+
		+	Als we de hele endpoint nog in PHP hebben staan, wordt de <code>whoswhopy.php.entry.Entry</code>-klasse gebruikt. Die zorgt ervoor dat PHP in CGI-modus wordt opgestart en een gegeven functie de request afhandelt. Het resultaat, de response, wordt dan letterlijk doorgegeven. In feite werkt Python dan als een soort webserver die een CGI-script aanroept.
		+
		+	Als de endpoint niet in Python gedefinieerd is, gebruiken we de fallback: deze werkt net als de PHP-entry door middel van CGI maar gooit de hele request, inclusief URL, door Benamite. Vervolgens wordt weer de bijbehorende functie aangeroepen en de response doorgestuurd.

	== Codestijl ==		== Codestijl ==

@@ Line 8: / Line 8: @@
 WhosWhoPy heeft als kern een hoop modelklassen (de (klein)kindklassen van <code>Entiteit</code>) die gegenereerd worden op basis van een klassediagram. Daarnaast hebben we wat hulpfuncties om de klassen op elkaar te laten werken, en een paar scripts die die hulpfuncties aanroepen. Specifiekere onderdelen worden hieronder toegelicht.
 === whoswhopy.config ===
@@ Line 20: / Line 30: @@
 Bevat de gegenereerde code van <code>dia2py</code>, zie verderop.
 == Codestijl ==