Roles web y de trabajo de Python con herramientas de Python para Visual Studio

Artículo
06/01/2023

Importante

Cloud Services (clásico) ahora está en desuso para los nuevos clientes y se retirará el 31 de agosto de 2024 para todos los clientes. Las nuevas implementaciones deben utilizar el nuevo modelo de implementación basado en Azure Resource Manager Azure Cloud Services (soporte extendido) .

En este artículo se ofrece información general sobre el uso de roles web y de trabajo de Python con herramientas de Python para Visual Studio. Obtenga información acerca de cómo usar Visual Studio para crear e implementar un servicio en la nube básico que usa Python.

Requisitos previos

Nota

Para completar este tutorial, deberá tener una cuenta de Azure. Puede activar sus beneficios de suscriptor de Visual Studio o registrarse para obtener una evaluación gratuita.

¿Qué son los roles web y de trabajo de Python?

Azure ofrece tres modelos de proceso para la ejecución de aplicaciones: característica Web Apps de Azure App Service, Azure Virtual Machines, and Azure Cloud Services. Los tres modelos admiten Python. Cloud Services, que incluye roles web y de trabajo, proporciona una Plataforma como servicio (PaaS). En un servicio en la nube, un rol web ofrece un servidor web dedicado de Internet Information Services (IIS) para hospedar aplicaciones web front-end, mientras que un rol de trabajo puede ejecutar tareas asincrónicas, de ejecución prolongada o tareas perpetuas independientes de la entrada o la interacción del usuario.

Para más información, consulte ¿Qué es un servicio en la nube?

Nota:

¿Desea compilar un sitio web sencillo? Si el escenario solo requiere un sitio web de front-end sencillo, considere la posibilidad de usar la característica Web Apps ligera en Azure App Service. Puede actualizar a un Servicio en la nube más adelante, cuando su sitio web sea más grande y sus requisitos cambien. Consulte el Centro para desarrolladores de Python para obtener artículos sobre el desarrollo de la característica Web Apps en Azure App Service.

Creación de un proyecto

En Visual Studio, puede seleccionar Servicio en la nube de Azure en el cuadro de diálogo Nuevo proyecto, en Python.

Cuadro de diálogo Nuevo proyecto

En el asistente Servicio en la nube de Azure, puede crear roles web y de trabajo nuevos.

Cuadro de diálogo Servicio en la nube de Azure

La plantilla de rol de trabajo incluye código reutilizable que conecta a una cuenta de Azure Storage o Azure Service Bus.

Solución de servicio en la nube

Puede agregar roles web o de trabajo a un servicio en la nube que ya existe en cualquier momento. Puede optar por agregar proyectos existentes a su solución o por crear otros nuevos.

Comando Agregar rol

Su servicio en la nube puede contener roles implementados en diferentes lenguajes. Por ejemplo, puede tener un rol web de Python implementado con Django, con Python o con roles de trabajo de C#. Puede comunicarse fácilmente entre sus roles usando colas de Service Bus o colas de almacenamiento.

Instalación de Python en el servicio en la nube

Advertencia

No funcionan los scripts de configuración que se instalaron con Visual Studio (en el momento en que se actualizó por última vez este artículo). En esta sección se describe una solución alternativa.

El problema principal con los scripts de configuración consiste en que instalan Python. En primer lugar, defina dos tareas de inicio en el archivo ServiceDefinition.csdef. La primera tarea (PrepPython.ps1) descarga e instala el entorno de tiempo de ejecución de Python. La segunda tarea (PipInstaller.ps1) ejecuta pip para instalar todas las dependencias que pueda tener.

Los siguientes scripts se escribieron para Python 3.8. Si desea usar la versión 2.x de Python, establezca el archivo de variables PYTHON2 en activado para las dos tareas de inicio y la tarea en tiempo de ejecución: <Variable name="PYTHON2" value="<mark>on</mark>" />.

<Startup>

  <Task executionContext="elevated" taskType="simple" commandLine="bin\ps.cmd PrepPython.ps1">
    <Environment>
      <Variable name="EMULATED">
        <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
      </Variable>
      <Variable name="PYTHON2" value="off" />
    </Environment>
  </Task>

  <Task executionContext="elevated" taskType="simple" commandLine="bin\ps.cmd PipInstaller.ps1">
    <Environment>
      <Variable name="EMULATED">
        <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
      </Variable>
      <Variable name="PYTHON2" value="off" />
    </Environment>

  </Task>

</Startup>

Se deben agregar las variables PYTHON2 y PYPATH a la tarea de inicio del trabajo. La variable PYPATH solo se usa si la variable PYTHON2 se establece en activado.

<Runtime>
  <Environment>
    <Variable name="EMULATED">
      <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
    </Variable>
    <Variable name="PYTHON2" value="off" />
    <Variable name="PYPATH" value="%SystemDrive%\Python27" />
  </Environment>
  <EntryPoint>
    <ProgramEntryPoint commandLine="bin\ps.cmd LaunchWorker.ps1" setReadyOnProcessStart="true" />
  </EntryPoint>
</Runtime>

Archivo ServiceDefinition.csdef de ejemplo

<?xml version="1.0" encoding="utf-8"?>
<ServiceDefinition name="AzureCloudServicePython" xmlns="http://schemas.microsoft.com/ServiceHosting/2008/10/ServiceDefinition" schemaVersion="2015-04.2.6">
  <WorkerRole name="WorkerRole1" vmsize="Small">
    <ConfigurationSettings>
      <Setting name="Microsoft.WindowsAzure.Plugins.Diagnostics.ConnectionString" />
      <Setting name="Python2" />
    </ConfigurationSettings>
    <Startup>
      <Task executionContext="elevated" taskType="simple" commandLine="bin\ps.cmd PrepPython.ps1">
        <Environment>
          <Variable name="EMULATED">
            <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
          </Variable>
          <Variable name="PYTHON2" value="off" />
        </Environment>
      </Task>
      <Task executionContext="elevated" taskType="simple" commandLine="bin\ps.cmd PipInstaller.ps1">
        <Environment>
          <Variable name="EMULATED">
            <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
          </Variable>
          <Variable name="PYTHON2" value="off" />
        </Environment>
      </Task>
    </Startup>
    <Runtime>
      <Environment>
        <Variable name="EMULATED">
          <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
        </Variable>
        <Variable name="PYTHON2" value="off" />
        <Variable name="PYPATH" value="%SystemDrive%\Python27" />
      </Environment>
      <EntryPoint>
        <ProgramEntryPoint commandLine="bin\ps.cmd LaunchWorker.ps1" setReadyOnProcessStart="true" />
      </EntryPoint>
    </Runtime>
    <Imports>
      <Import moduleName="RemoteAccess" />
      <Import moduleName="RemoteForwarder" />
    </Imports>
  </WorkerRole>
</ServiceDefinition>

A continuación, cree los archivos PrepPython.ps1 y PipInstaller.ps1 en la carpeta ./bin del rol.

PrepPython.ps1

Este script instala Python. Si la variable de entorno PYTHON2 se establece en on (activado), se instala Python 2.7; de lo contrario, se instala Python 3.8.

[Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls"
$is_emulated = $env:EMULATED -eq "true"
$is_python2 = $env:PYTHON2 -eq "on"
$nl = [Environment]::NewLine

if (-not $is_emulated){
    Write-Output "Checking if Python is installed...$nl"
    if ($is_python2) {
        & "${env:SystemDrive}\Python27\python.exe"  -V | Out-Null
    }
    else {
        py -V | Out-Null
    }

    if (-not $?) {

        $url = "https://www.python.org/ftp/python/3.8.8/python-3.8.8-amd64.exe"
        $outFile = "${env:TEMP}\python-3.8.8-amd64.exe"

        if ($is_python2) {
            $url = "https://www.python.org/ftp/python/2.7.18/python-2.7.18.amd64.msi"
            $outFile = "${env:TEMP}\python-2.7.18.amd64.msi"
        }

        Write-Output "Not found, downloading $url to $outFile$nl"
        Invoke-WebRequest $url -OutFile $outFile
        Write-Output "Installing$nl"

        if ($is_python2) {
            Start-Process msiexec.exe -ArgumentList "/q", "/i", "$outFile", "ALLUSERS=1" -Wait
        }
        else {
            Start-Process "$outFile" -ArgumentList "/quiet", "InstallAllUsers=1" -Wait
        }

        Write-Output "Done$nl"
    }
    else {
        Write-Output "Already installed"
    }
}

PipInstaller.ps1

Este script se llama pip e instala todas las dependencias en el archivo requirements.txt. Si la variable de entorno PYTHON2 se establece en on (activado) se usa Python 2.7; de lo contrario, se usa Python 3.8.

$is_emulated = $env:EMULATED -eq "true"
$is_python2 = $env:PYTHON2 -eq "on"
$nl = [Environment]::NewLine

if (-not $is_emulated){
    Write-Output "Checking if requirements.txt exists$nl"
    if (Test-Path ..\requirements.txt) {
        Write-Output "Found. Processing pip$nl"

        if ($is_python2) {
            & "${env:SystemDrive}\Python27\python.exe" -m pip install -r ..\requirements.txt
        }
        else {
            py -m pip install -r ..\requirements.txt
        }

        Write-Output "Done$nl"
    }
    else {
        Write-Output "Not found$nl"
    }
}

Modificación del archivo LaunchWorker.ps1

Nota:

En caso de un proyecto de rol de trabajo, se necesita el archivo LauncherWorker.ps1 para ejecutar el archivo de inicio. En un proyecto de rol web, el archivo de inicio se define por el contrario en las propiedades del proyecto.

El archivo bin\LaunchWorker.ps1 se creó originalmente para hacer una gran cantidad de trabajo de preparación pero realmente no funciona. Reemplace el contenido del archivo por el script siguiente.

Este script llama al archivo worker.py desde el proyecto de Python. Si la variable de entorno PYTHON2 se establece en on (activado) se usa Python 2.7; de lo contrario, se usa Python 3.8.

$is_emulated = $env:EMULATED -eq "true"
$is_python2 = $env:PYTHON2 -eq "on"
$nl = [Environment]::NewLine

if (-not $is_emulated)
{
    Write-Output "Running worker.py$nl"

    if ($is_python2) {
        cd..
        iex "$env:PYPATH\python.exe worker.py"
    }
    else {
        cd..
        iex "py worker.py"
    }
}
else
{
    Write-Output "Running (EMULATED) worker.py$nl"

    # Customize to your local dev environment

    if ($is_python2) {
        cd..
        iex "$env:PYPATH\python.exe worker.py"
    }
    else {
        cd..
        iex "py worker.py"
    }
}

ps.cmd

Las plantillas de Visual Studio deben haber creado un archivo ps.cmd en la carpeta ./bin. Este script de shell llama a los scripts anteriores del contenedor de PowerShell y proporciona un registro basado en el nombre del contenedor de PowerShell que se ha llamado. Si no se ha creado este archivo, esto es lo que debería haber en él.

@echo off

cd /D %~dp0

if not exist "%DiagnosticStore%\LogFiles" mkdir "%DiagnosticStore%\LogFiles"
%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe -ExecutionPolicy Unrestricted -File %* >> "%DiagnosticStore%\LogFiles\%~n1.txt" 2>> "%DiagnosticStore%\LogFiles\%~n1.err.txt"

Ejecución en modo local

Si establece su proyecto de servicio en la nube como proyecto de inicio y presiona F5, el servicio en la nube se ejecuta en el emulador de Azure local.

Aunque PTVS admite el inicio en el emulador, la depuración (por ejemplo, puntos de interrupción) no funciona.

Para depurar roles web y de trabajo, puede establecer el proyecto de rol como proyecto de inicio y depurarlo. También puede establecer varios proyectos de inicio. Haga clic con el botón derecho en la solución y luego seleccione Establecer proyectos de inicio.

Propiedades del proyecto de inicio de la solución

Publicación en Azure

Para publicar, haga clic con el botón derecho en el proyecto del servicio en la nube de la solución y luego seleccione Publicar.

Inicio de sesión para publicación de Microsoft Azure

Siga las instrucciones del asistente. Si es necesario, habilite el Escritorio remoto. El Escritorio remoto es útil cuando necesita depurar algo.

Cuando haya terminado la configuración, haga clic en Publicar.

En la ventana de salida se ve cierto progreso y después se verá la ventana Registro de actividad de Microsoft Azure.

Ventana Registro de actividad de Microsoft Azure

La implementación tarda varios minutos y después sus roles web y/o de trabajo estarán ejecutándose en Azure.

Investigación de registros

Después de que la máquina virtual del servicio en la nube se inicie e instale Python, puede mirar los registros para buscar mensajes de error. Estos registros se encuentran en la carpeta C:\Resources\Directory\{role}\LogFiles. PrepPython.err.txt tiene al menos un error cuando el script intente detectar si está instalado Python y PipInstaller.err.txt puede informar acerca de una versión obsoleta de pip.

Pasos siguientes

Para obtener información detallada sobre el trabajo con roles web y de trabajo en Python Tools para Visual Studio, consulte la documentación de PTVS:

Proyectos de servicio en la nube

Para más información sobre el uso de servicios de Azure desde roles web y de trabajo, como el uso de Azure Storage o Service Bus, consulte los siguientes artículos: