Utilizzo del server di sviluppo locale

Puoi utilizzare il server di sviluppo locale per simulare l'esecuzione dell'applicazione App Engine in produzione e utilizzarlo per accedere ai servizi in bundle di App Engine.

L'ambiente simulato applica alcune restrizioni della sandbox, come funzioni di sistema limitate e importazioni dei moduli Python 2, ma non altre, come timeout delle richieste o quote.

Il server di sviluppo locale simula inoltre i servizi forniti dalle librerie nell'SDK per App Engine, inclusi Datastore, Memcache e code di attività, eseguendo le attività localmente. Quando l'applicazione è in esecuzione sul server di sviluppo, puoi comunque effettuare chiamate API remote all'infrastruttura di produzione utilizzando gli endpoint HTTP delle API di Google.

Prima di iniziare

Poiché Python 2.7 ha raggiunto la fine del supporto, non puoi più utilizzare l'ultima versione di dev_appserver.py per eseguire le tue applicazioni localmente. Per scaricare una versione archiviata di devapp_server.py, procedi nel seguente modo:

  1. Dall'archivio, scarica la cartella compressa che contiene il server dev_appserver.py per i runtime che hanno raggiunto la fine del supporto.

  2. Estrai i contenuti della directory nel tuo file system locale, ad esempio nella directory /home. Puoi trovare dev_appserver.py nella directory google_appengine/.

Configurare il server di sviluppo locale

Per eseguire lo strumento del server di sviluppo locale, devi configurare quanto segue:

  1. Verificare di aver installato un interprete Python 2 della versione 2.7.12 o successiva.

  2. Imposta la variabile di ambiente DEVAPPSERVER_ROOT nella tua shell sul percorso dell'interprete Python 2.

Esegui il server di sviluppo locale

Dopo aver configurato il server di sviluppo locale e creato il file di configurazione di app.yaml per la tua app, puoi utilizzare il comando dev_appserver.py per eseguire l'app localmente.

Per avviare il server di sviluppo locale:

  1. Nella directory che contiene il file di configurazione app.yaml, esegui il comando dev_appserver.py.

    Specifica il percorso della directory dell'app, ad esempio:

         python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py [PATH_TO_YOUR_APP]
    

    In alternativa, puoi specificare il file di configurazione di un servizio specifico, ad esempio:

         python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py app.yaml
    

    Per modificare la porta, includi l'opzione --port:

         python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --port=9999 [PATH_TO_YOUR_APP]
    

    Sostituisci [DEVAPPSERVER_ROOT] con il percorso della cartella in cui estrai la versione archiviata di devapp_server.py.

    Per scoprire di più sulle opzioni del comando dev_appserver.py, consulta Opzioni del server di sviluppo locale.

  2. Il server di sviluppo locale è ora in esecuzione e rimane in attesa delle richieste. Puoi visitare l'indirizzo http://localhost:8080/ nel browser web per vedere l'applicazione in azione.

    Se hai specificato una porta personalizzata con l'opzione --port, ricordati di aprire il browser su quella porta.

Per arrestare il server locale dalla riga di comando, premi quanto segue:

  • macOS o Linux: Ctrl+C
  • Windows: Ctrl+Interruzione

Specifica gli ID applicazione

Per accedere al tuo ID app nel server locale, ad esempio per eseguire lo spoofing di un indirizzo email, utilizza la funzione get_application_id(). Per ottenere il nome host dell'app in esecuzione, utilizza la funzione get_default_version_hostname().

Rilevamento dell'ambiente di runtime delle applicazioni

Per determinare se il codice è in esecuzione in produzione o sul server di sviluppo locale, puoi controllare il valore della variabile di ambiente SERVER_SOFTWARE:

if os.getenv('SERVER_SOFTWARE', '').startswith('Google App Engine/'):
  # Production
else:
  # Local development server

Utilizzo del datastore locale

Il server di sviluppo locale simula il datastore di App Engine utilizzando un file locale che persiste tra una chiamata al server locale e l'altra.

Per saperne di più sugli indici e index.yaml, consulta le pagine Indici di Datastore e Configurazione degli indici datastore.

Sfogliare il datastore locale

Se l'app ha scritto dati nel datastore locale utilizzando il server di sviluppo locale, puoi esaminarli nella console di sviluppo locale.

Per sfogliare il datastore locale:

  1. Avvia il server di sviluppo.

  2. Accedi a Visualizzatore Datastore nella console di sviluppo locale. (L'URL è http://localhost:8000/datastore).

  3. Visualizzare i contenuti Datastore locali.

Specifica il criterio di allocazione degli ID

Per App Engine di produzione, puoi impostare Datastore in modo da generare automaticamente ID entità.

Sebbene i criteri di assegnazione automatica degli ID per il server di produzione siano completamente diversi da quelli utilizzati dal server di sviluppo, puoi anche impostare i criteri di allocazione automatica degli ID per il server locale.

Per specificare il criterio di assegnazione automatica degli ID, utilizza l'opzione --auto_id_policy:

python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --auto_id_policy=sequential

Sostituisci:

  • DEVAPPSERVER_ROOT con il percorso della cartella in cui hai estratto la versione archiviata di devapp_server.py.

  • --auto_id_policy con uno dei seguenti tipi di documenti:

    • scattered quando (valore predefinito) gli ID vengono assegnati da una sequenza non ripetuta di numeri interi distribuiti approssimativamente in modo uniforme.
    • sequential quando vengono assegnati ID dalla sequenza di numeri interi consecutivi.

Cancellazione dei dati del datastore locale

Per cancellare il datastore locale per un'applicazione, richiama il server di sviluppo locale come segue:

python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --clear_datastore=yes app.yaml

Sostituisci DEVAPPSERVER_ROOT con il percorso della cartella in cui hai estratto la versione archiviata di devapp_server.py.

Modifica la località Datastore locale

Per modificare la posizione utilizzata per il file del datastore, utilizza l'opzione --datastore_path:

python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --datastore_path=/tmp/myapp_datastore app.yaml

Sostituisci DEVAPPSERVER_ROOT con il percorso della cartella in cui estrai la versione archiviata di devapp_server.py.

Utilizzare il servizio Utenti

App Engine fornisce un servizio utenti per semplificare l'autenticazione e l'autorizzazione per l'applicazione. Il server di sviluppo locale simula il comportamento degli Account Google con le proprie pagine di accesso e uscita. Durante l'esecuzione nel server di sviluppo locale, le funzioni users.create_login_url e users.create_logout_url restituiscono gli URL per /_ah/login e /_ah/logout sul server locale.

Utilizza Mail

Il server di sviluppo locale può inviare email per le chiamate al servizio di posta App Engine utilizzando un server SMTP o un'installazione locale di Sendmail.

Utilizzo di SMTP

Per attivare il supporto della posta con un server SMTP, richiama dev_appserver.py come segue:

   python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --smtp_host=smtp.example.com --smtp_port=25 \
    --smtp_user=ajohnson --smtp_password=k1tt3ns [PATH_TO_YOUR_APP]

Sostituisci:

  • [DEVAPPSERVER_ROOT] con il percorso della cartella in cui hai estratto la versione archiviata di devapp_server.py.
  • Opzioni --smtp_host, --smtp_port, --smtp_user e --smtp_password con i tuoi valori di configurazione.

Utilizzo di Sendmail

Per attivare il supporto email con Sendmail, richiama dev_appserver.py come segue:

   python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --enable_sendmail=yes [PATH_TO_YOUR_APP]

Sostituisci [DEVAPPSERVER_ROOT] con il percorso della cartella in cui hai estratto la versione archiviata di devapp_server.py.

Il server locale utilizzerà il comando sendmail per inviare messaggi email con la configurazione predefinita dell'installazione.

Usa il recupero URL

Quando l'applicazione utilizza l'API di recupero URL per effettuare una richiesta HTTP, il server di sviluppo locale effettua la richiesta direttamente dal tuo computer. Il comportamento di recupero degli URL sul server locale potrebbe essere diverso da quello di produzione di App Engine se utilizzi un server proxy per accedere ai siti web.

Utilizzare la console interattiva

La console interattiva consente agli sviluppatori di inserire codice Python arbitrario in un modulo web ed eseguirlo all'interno dell'ambiente dell'app; fornisce lo stesso accesso all'ambiente e ai servizi dell'applicazione di un file .py all'interno dell'applicazione stessa.

Per utilizzare la console interattiva:

  1. Avvia il server di sviluppo.

  2. Accedi alla console interattiva nella console di sviluppo locale. (L'URL è http://localhost:8000/console).

  3. Inserisci qualsiasi codice Python che vuoi eseguire nell'area di testo, quindi invia il modulo per eseguirlo. Ad esempio, nel codice seguente verrà aggiunta un'entità Datastore denominata Greeting con contenuto testuale Hello:

      from google.appengine.ext import ndb
      class Greeting(ndb.Model):
        content = ndb.TextProperty()
    
      e = Greeting(content="Hello")
      e.put()
    

Debug con il debugger Python

Per utilizzare il debugger Python (pdb):

  1. Aggiungi la seguente riga al codice:

    import pdb; pdb.set_trace();
    

    A questo punto, dev_appserver eseguirà l'interruzione e passerà al REPL pdb (read-eval-print loop), consentendoti di eseguire il debug del codice dalla riga di comando.

  2. Se la tua applicazione effettua più richieste simultanee che richiamano pdb.set_trace(), verranno avviate contemporaneamente più sessioni di debug, ciascuna delle quali invia l'output a STDOUT. Per evitare che ciò accada, serializza le tue richieste disattivando il supporto per il multi-threading e dell'elaborazione multi-elaborazione di dev_appserver, come indicato di seguito:

    1. Disabilita il multi-threading per:

      • Tutti i servizi che utilizzano il flag --threadsafe_override=false.
      • Un servizio con il flag --threadsafe_override=<SERVICENAME>:false.
      • Più servizi con il flag --threadsafe_override=<SERVICE1NAME>:false,<SERVICE2NAME>:false.
    2. Disattiva l'elaborazione multipla per:

      • Tutti i servizi che utilizzano il flag --max_module_instances=1.
      • Un servizio con il flag --max_module_instances=<SERVICENAME>:1.
      • Più servizi con il flag --max_module_instances=<SERVICE1NAME>:1,<SERVICE2NAME>:1.