Voor het maken van een aangepaste opdrachtregelinterface (CLI) voor je Flask-toepassing kun je gebruik maken van de standaard Python-module `click` of de ingebouwde `argparse`. `click` is vaak favoriet vanwege de eenvoud en uitgebreide functionaliteit, vooral voor complexere CLI's. Hier is een overzicht van hoe je dit kunt aanpakken: 1. **Aangepaste opdrachten definiëren:** - Maak een script (bijvoorbeeld `manage.py`) in je projectroot. - Gebruik `click` om commando’s te registreren met decorators. - Bijvoorbeeld: ```python import click from app import app # importeer je Flask app @click.group() def cli(): """CLI voor mijn Flask-project""" pass @cli.command() def run(): """Start de Flask server""" app.run() @cli.command() def migrate(): """Voer database migraties uit""" # code voor migratie pass if __name__ == '__main__': cli() ``` 2. **Opdrachtregelargumenten beheren:** - Gebruik decorator-parameters om opties en argumenten toe te voegen: ```python @cli.command() @click.option('--host', default='127.0.0.1', help='Hostnaam om te gebruiken') @click.option('--port', default=5000, help='Poortnummer') def run(host, port): app.run(host=host, port=port) ``` - Dit stelt je in staat om flexibel parameters te doorgeven bij het uitvoeren van opdrachten. 3. **Helpdocumentatie voor elke opdracht:** - Voeg docstrings toe aan elke command-functie: ```python @cli.command() def migrate(): """Voert database migraties uit met Alembic""" pass ``` - `click` toont automatisch deze helpteksten bij het gebruik van `--help`. 4. **Beste praktijken voor gebruiksvriendelijkheid en efficiëntie:** - **Consistente naamgeving:** Gebruik duidelijke en consistente commando- en option-namen. - **Automatische help:** Zorg dat elke opdracht een duidelijke helptekst heeft. - **Gebruik van default-waarden:** Stel logische standaardwaarden in voor opties. - **Error handling:** Geef informatieve foutmeldingen. - **Documentatie:** Documenteer je CLI in een README of inline. - **Integratie met Flask CLI:** Overweeg om je CLI te integreren met `flask` commands door `app` te gebruiken als context, bijvoorbeeld: ```python from flask.cli import with_appcontext @click.command('migrate') @with_appcontext def migrate(): # migratie code pass app.cli.add_command(migrate) ``` - **Automatisering:** Automatiseer veelgebruikte taken en zorg dat je CLI snel en betrouwbaar is. Door deze aanpak te volgen, creëer je een gebruiksvriendelijke en efficiënte CLI die je ontwikkelings- en implementatietaken stroomlijnt.

Hier is een uitgebreide uitleg over het maken van een aangepaste CLI voor je Flask-applicatie: ## 1. CLI Framework Keuze Voor Flask raad ik **Click** aan - het is speciaal ontworpen voor Flask en zeer gebruiksvriendelijk: ```bash pip install click ``` ## 2. Basis CLI Setup Voeg dit toe aan je `app.py`: ```python import click from flask import Flask app = Flask(__name__) @app.cli.command() def hello(): """Eenvoudige begroetingscommando""" click.echo("Hallo vanuit de Flask CLI!") # Of met Click groepen voor betere organisatie @app.cli.group() def dev(): """Ontwikkelaarscommando's""" pass @dev.command() def setup(): """Initialiseer ontwikkelingsomgeving""" click.echo("Ontwikkelomgeving wordt ingesteld...") # Voer setup taken uit ``` ## 3. Geavanceerde Commando's met Argumenten ```python @app.cli.command() @click.option('--name', default='gebruiker', help='Naam om te begroeten') @click.option('--count', default=1, help='Aantal keren om te begroeten') @click.argument('environment', type=click.Choice(['dev', 'prod', 'test'])) def deploy(name, count, environment): """Implementeer applicatie naar specifieke omgeving ARGUMENTEN: environment - Doelomgeving (dev/prod/test) """ for i in range(count): click.echo(f"Hallo {name}! Implementeren naar {environment}...") # Implementatielogica hier if environment == 'prod': click.confirm('Weet je zeker dat je naar productie wilt implementeren?', abort=True) ``` ## 4. Gebruikersvriendelijke Best Practices ### Duidelijke Help Teksten ```python @app.cli.command() @click.option('--verbose', '-v', is_flag=True, help='Uitgebreide output') @click.option('--force', '-f', is_flag=True, help='Forceer actie zonder bevestiging') def database_reset(verbose, force): """Reset database naar initiële staat WAARSCHUWING: Dit verwijdert alle bestaande data! Gebruik alleen in ontwikkelomgeving. """ if not force: click.confirm('Database resetten? Alle data gaat verloren!', abort=True) if verbose: click.echo("Database reset gestart...") ``` ### Kleurgebruik en Formatting ```python def success_message(message): click.secho(f"✓ {message}", fg='green') def error_message(message): click.secho(f"✗ {message}", fg='red') def warning_message(message): click.secho(f"⚠ {message}", fg='yellow') @app.cli.command() def health_check(): """Controleer applicatie gezondheid""" try: # Health check logica success_message("Alle services zijn gezond") except Exception as e: error_message(f"Health check gefaald: {e}") ``` ## 5. Commando Groepering ```python @app.cli.group() def db(): """Database management commando's""" pass @db.command() def migrate(): """Voer database migraties uit""" click.echo("Migraties uitvoeren...") success_message("Migraties voltooid") @db.command() @click.option('--sample-data', is_flag=True, help='Voeg voorbeelddata toe') def seed(sample_data): """Seed database met initiële data""" click.echo("Database seeden...") if sample_data: click.echo("Voorbeelddata toevoegen...") success_message("Seeding voltooid") ``` ## 6. Foutafhandeling ```python @app.cli.command() @click.argument('config_file', type=click.Path(exists=True)) def validate_config(config_file): """Valideer configuratiebestand""" try: with open(config_file, 'r') as f: # Validatielogica pass success_message("Configuratie is geldig") except FileNotFoundError: error_message(f"Configuratiebestand niet gevonden: {config_file}") except Exception as e: error_message(f"Validatie mislukt: {e}") ``` ## 7. Beste Praktijken ### Consistentie in Commandostructuur ```bash flask dev setup # Ontwikkeling setup flask db migrate # Database migratie flask db seed # Database seeding flask deploy prod # Productie implementatie ``` ### Progress Indicators ```python import time @app.cli.command() def long_running_task(): """Langlopende taak met progress indicator""" with click.progressbar(range(100), label='Verwerken...') as bar: for i in bar: time.sleep(0.1) # Simuleer werk success_message("Taak voltooid") ``` ### Environment-specifieke Commando's ```python @app.cli.command() @click.pass_context def dev_only(ctx): """Alleen beschikbaar in ontwikkelomgeving""" if app.config['ENV'] != 'development': error_message("Dit commando is alleen voor ontwikkelomgeving") ctx.exit(1) click.echo("Ontwikkelcommando uitgevoerd") ``` ## Gebruik ```bash # Help zien flask --help flask db --help flask deploy --help # Commando's uitvoeren flask hello flask db migrate flask deploy prod --name "mijn-app" --count 3 ``` Deze aanpak zorgt voor een professionele, gebruiksvriendelijke CLI die je ontwikkelworkflow aanzienlijk verbetert!