आप विभिन्न उपकरणों का उपयोग करके REST API सेवा को विभिन्न तरीकों से कार्यान्वित कर सकते हैं। वर्णित समाधान एकमात्र सही नहीं है, मैंने अपने व्यक्तिगत अनुभव और वरीयताओं के आधार पर कार्यान्वयन और उपकरण चुना।

• हम क्या करें?
• क्या उपकरण चुनने के लिए?
• विकास
  
  • आपको setup.py के साथ शुरुआत करने की आवश्यकता क्यों है?
  • निर्भरता संस्करण कैसे निर्दिष्ट करें?
  • डेटाबेस
    
    • हम योजना को डिजाइन करते हैं
    • SQLAlchemy में स्कीमा का वर्णन करें
    • अलेम्बिक को अनुकूलित करें
    • हम पलायन पैदा करते हैं
  • आवेदन
    • डेटा क्रमांकन
    • हैंडलर
      • पोस्ट / आयात
      • GET / आयात / $ import_id / नागरिक
      • PATCH / आयात / $ import_id / नागरिक / $ Cit_id
      • GET / आयात / $ import_id / नागरिक / जन्मदिन
      • GET / आयात / $ import_id / कस्बों / स्टेट / प्रतिशत / आयु
• परिक्षण
  • हैंडलर
    • GET / आयात / $ import_id / नागरिक
    • पोस्ट / आयात
    • PATCH / आयात / $ import_id / नागरिक / $ Cit_id
    • GET / आयात / $ import_id / नागरिक / जन्मदिन
    • GET / आयात / $ import_id / कस्बों / स्टेट / प्रतिशत / आयु
  • माइग्रेशन
• सभा
• Ci
• तैनाती
• तनाव परीक्षण
• और क्या किया जा सकता है?
• आखिरकार

हम क्या करें?

• POST /imports
  डेटा के साथ एक नया अपलोड जोड़ता है;
  
• GET /imports/$import_id/citizens
  निर्दिष्ट निर्वहन के निवासियों को वापस करता है;
  
• PATCH /imports/$import_id/citizens/$citizen_id
  निर्दिष्ट उतराई में निवासी (और उसके रिश्तेदारों) के बारे में जानकारी में परिवर्तन;
  
• GET /imports/$import_id/citizens/birthdays
  , ( ), ;
  
• GET /imports/$import_id/towns/stat/percentile/age
  50-, 75- 99- ( ) .
  

?

विकास

$ python
>>> import analyzer
>>> help(analyzer)

Help on package analyzer:

NAME
    analyzer

DESCRIPTION
      REST API,    .

PACKAGE CONTENTS
    api (package)
    db (package)
    utils (package)

DATA
    __all__ = ('__author__', '__email__', '__license__', '__maintainer__',...
    __email__ = 'alvassin@yandex.ru'
    __license__ = 'MIT'
    __maintainer__ = 'Alexander Vasin'

VERSION
    0.0.1

AUTHOR
    Alexander Vasin

FILE
    /Users/alvassin/Work/backendschool2019/analyzer/__init__.py

# REST API
$ python -m analyzer.api --help

#    
$ python -m analyzer.db --help

आपको setup.py के साथ शुरुआत करने की आवश्यकता क्यों है?

setup(..., install_requires=["aiohttp", "SQLAlchemy"])

def load_requirements(fname: str) -> list:
    requirements = []
    with open(fname, 'r') as fp:
        for req in parse_requirements(fp.read()):
            extras = '[{}]'.format(','.join(req.extras)) if req.extras else ''
            requirements.append(
                '{}{}{}'.format(req.name, extras, req.specifier)
            )
    return requirements

import os
from importlib.machinery import SourceFileLoader

from pkg_resources import parse_requirements
from setuptools import find_packages, setup

module_name = 'analyzer'

# ,     (   ), 
#   __init__.py   machinery.
module = SourceFileLoader(
    module_name, os.path.join(module_name, '__init__.py')
).load_module()

def load_requirements(fname: str) -> list:
    requirements = []
    with open(fname, 'r') as fp:
        for req in parse_requirements(fp.read()):
            extras = '[{}]'.format(','.join(req.extras)) if req.extras else ''
            requirements.append(
                '{}{}{}'.format(req.name, extras, req.specifier)
            )
    return requirements

setup(
    name=module_name,
    version=module.__version__,
    author=module.__author__,
    author_email=module.__email__,
    license=module.__license__,
    description=module.__doc__,
    long_description=open('README.rst').read(),
    url='https://github.com/alvassin/backendschool2019',
    platforms='all',
    classifiers=[
        'Intended Audience :: Developers',
        'Natural Language :: Russian',
        'Operating System :: MacOS',
        'Operating System :: POSIX',
        'Programming Language :: Python',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: Implementation :: CPython'
    ],
    python_requires='>=3.8',
    packages=find_packages(exclude=['tests']),
    install_requires=load_requirements('requirements.txt'),
    extras_require={'dev': load_requirements('requirements.dev.txt')},
    entry_points={
        'console_scripts': [
            # f-strings  setup.py   - 
            # .
            #   ,     Python 3.8, 
            # source distribution       
            #   Python.     
            # .
            '{0}-api = {0}.api.__main__:main'.format(module_name),
            '{0}-db = {0}.db.__main__:main'.format(module_name)
        ]
    },
    include_package_data=True
)

#      extra- "dev"
pip install -e '.[dev]'

#      
pip install -e .

निर्भरता संस्करण कैसे निर्दिष्ट करें?

• MAJOR - जब पिछड़े असंगत परिवर्तन बढ़ जाते हैं;
• MINOR - पिछड़े संगतता के लिए समर्थन के साथ नई कार्यक्षमता जोड़ते समय बढ़ जाती है;
• PATCH - पश्चगामी संगतता समर्थन के साथ बग फिक्स जोड़ते समय वृद्धि होती है।

डेटाबेस

हम योजना को डिजाइन करते हैं

{
  "citizens": [
    {
      "citizen_id": 1,
      "town": "",
      "street": " ",
      "building": "1675",
      "apartment": 7,
      "name": "  ",
      "birth_date": "26.12.1986",
      "gender": "male",
      "relatives": [2]
    },
    {
      "citizen_id": 2,
      "town": "",
      "street": " ",
      "building": "1675",
      "apartment": 7,
      "name": "  ",
      "birth_date": "01.04.1997",
      "gender": "male",
      "relatives": [1]
    },
    {
      "citizen_id": 3,
      "town": "",
      "street": " ",
      "building": "2",
      "apartment": 11,
      "name": "  ",
      "birth_date": "23.11.1986",
      "gender": "female",
      "relatives": []
    },
    ...
  ]
}

1. आयात तालिका में स्वचालित रूप से इंक्रीमेंटिंग कॉलम होता है import_id। तालिका में एक विदेशी कुंजी जाँच बनाने के लिए यह आवश्यक है citizens।
   
2. नागरिक तालिका निवासी (पारिवारिक संबंधों के बारे में जानकारी को छोड़कर सभी क्षेत्रों) के बारे में स्केलर डेटा संग्रहीत करती है ।
   
   एक जोड़ी ( import_id, citizen_id) प्राथमिक कुंजी के रूप में किया जाता है , निवासियों की विशिष्टता की गारंटी citizen_idढांचे के भीतर import_id।
   
   एक विदेशी कुंजी citizens.import_id -> imports.import_idयह सुनिश्चित करती है कि फ़ील्ड citizens.import_idमें केवल मौजूदा अनलोड हैं।
   
3. relations .
   
   ( ): citizens relations .
   (import_id, citizen_id, relative_id) , import_id citizen_id c relative_id.
   
   : (relations.import_id, relations.citizen_id) -> (citizens.import_id, citizens.citizen_id) (relations.import_id, relations.relative_id) -> (citizens.import_id, citizens.citizen_id), , citizen_id relative_id .

SQLAlchemy में स्कीमा का वर्णन करें

# analyzer/db/schema.py
from sqlalchemy import MetaData

convention = {
    'all_column_names': lambda constraint, table: '_'.join([
        column.name for column in constraint.columns.values()
    ]),

    #  
    'ix': 'ix__%(table_name)s__%(all_column_names)s',

    #   
    'uq': 'uq__%(table_name)s__%(all_column_names)s',

    #  CHECK-constraint-
    'ck': 'ck__%(table_name)s__%(constraint_name)s',

    #   
    'fk': 'fk__%(table_name)s__%(all_column_names)s__%(referred_table_name)s',

    #   
    'pk': 'pk__%(table_name)s'
}
metadata = MetaData(naming_convention=convention)

# analyzer/db/schema.py
from enum import Enum, unique

from sqlalchemy import (
    Column, Date, Enum as PgEnum, ForeignKey, ForeignKeyConstraint, Integer,
    String, Table
)


@unique
class Gender(Enum):
    female = 'female'
    male = 'male'


imports_table = Table(
    'imports',
    metadata,
    Column('import_id', Integer, primary_key=True)
)

citizens_table = Table(
    'citizens',
    metadata,
    Column('import_id', Integer, ForeignKey('imports.import_id'),
           primary_key=True),
    Column('citizen_id', Integer, primary_key=True),
    Column('town', String, nullable=False, index=True),
    Column('street', String, nullable=False),
    Column('building', String, nullable=False),
    Column('apartment', Integer, nullable=False),
    Column('name', String, nullable=False),
    Column('birth_date', Date, nullable=False),
    Column('gender', PgEnum(Gender, name='gender'), nullable=False),
)

relations_table = Table(
    'relations',
    metadata,
    Column('import_id', Integer, primary_key=True),
    Column('citizen_id', Integer, primary_key=True),
    Column('relative_id', Integer, primary_key=True),
    ForeignKeyConstraint(
        ('import_id', 'citizen_id'),
        ('citizens.import_id', 'citizens.citizen_id')
    ),
    ForeignKeyConstraint(
        ('import_id', 'relative_id'),
        ('citizens.import_id', 'citizens.citizen_id')
    ),
)

अलेम्बिक को अनुकूलित करें

1. पैकेज स्थापित करे: pip install alembic
2. प्रारंभिक अलेम्बिक cd analyzer && alembic init db/alembic:।
   
   यह कमांड एक विन्यास फाइल analyzer/alembic.iniऔर एक फ़ोल्डर बनाएगी analyzer/db/alembicजिसमें निम्न सामग्री होगी:
   
   • env.py- हर बार जब आप अलेम्बिक शुरू करते हैं। sqlalchemy.MetaDataडेटाबेस की वांछित स्थिति के विवरण के साथ एलेम्बिक रजिस्ट्री से जोड़ता है और इसमें माइग्रेशन शुरू करने के निर्देश शामिल हैं।
     
   • script.py.mako - जिस आधार पर माइग्रेशन उत्पन्न होता है, उसके आधार पर टेम्प्लेट।
   • versions - वह फ़ोल्डर जिसमें अलेम्बिक माइग्रेशन खोजेगा (और उत्पन्न करेगा)।
3. डेटाबेस पते को alembic.ini फ़ाइल में निर्दिष्ट करें:
   
   

   ; analyzer/alembic.ini
   [alembic] 
   sqlalchemy.url = postgresql://user:hackme@localhost/analyzer

4. डेटाबेस (रजिस्ट्री sqlalchemy.MetaData) की वांछित स्थिति का विवरण निर्दिष्ट करें ताकि एलेबिक स्वचालित रूप से माइग्रेशन उत्पन्न कर सके:
   
   

   # analyzer/db/alembic/env.py
   from analyzer.db import schema
   target_metadata = schema.metadata

1. उपयोगिता वर्तमान कार्य निर्देशिका में alembicखोज करती alembic.iniहै। आप alembic.iniकमांड लाइन तर्क के लिए पथ निर्दिष्ट कर सकते हैं, लेकिन यह असुविधाजनक है: मैं अतिरिक्त मापदंडों के बिना किसी भी फ़ोल्डर से कमांड को कॉल करने में सक्षम होना चाहता हूं।
2. किसी विशिष्ट डेटाबेस के साथ काम करने के लिए एलेम्बिक को कॉन्फ़िगर करने के लिए, आपको फ़ाइल को बदलने की आवश्यकता है alembic.ini। उदाहरण के लिए, पर्यावरण चर और / या कमांड लाइन तर्क के लिए डेटाबेस सेटिंग्स निर्दिष्ट करना अधिक सुविधाजनक होगा --pg-url।
3. उपयोगिता alembicका नाम हमारी सेवा के नाम के साथ बहुत अच्छी तरह से संबंध नहीं रखता है (और उपयोगकर्ता वास्तव में अजगर बिल्कुल नहीं हो सकता है और एलेम्बिक के बारे में कुछ भी नहीं जानता है)। यह अंत उपयोगकर्ता के लिए बहुत सुविधाजनक होगा यदि सेवा के सभी निष्पादन योग्य आदेशों में एक सामान्य उपसर्ग था, उदाहरण के लिए analyzer-*।

• अलेम्बिक कमांड लाइन के तर्कों को संसाधित करने के लिए एक मानक मॉड्यूल का उपयोग करता है argparse। यह आपको --pg-urlपर्यावरण चर से डिफ़ॉल्ट मान के साथ एक वैकल्पिक तर्क जोड़ने की अनुमति देता है ANALYZER_PG_URL।
  
  
  कोड

  import os
  from alembic.config import CommandLine, Config
  from analyzer.utils.pg import DEFAULT_PG_URL
  
  
  def main():
      alembic = CommandLine()
      alembic.parser.add_argument(
          '--pg-url', default=os.getenv('ANALYZER_PG_URL', DEFAULT_PG_URL),
          help='Database URL [env var: ANALYZER_PG_URL]'
      )
      options = alembic.parser.parse_args()
  
      #    Alembic
      config = Config(file_=options.config, ini_section=options.name,
                      cmd_opts=options)
  
      #   sqlalchemy.url   Alembic
      config.set_main_option('sqlalchemy.url', options.pg_url)
  
      #   alembic
      exit(alembic.run_cmd(config, options))
  
  
  if __name__ == '__main__':
      main()

• फ़ाइल का पथ alembic.iniनिष्पादन योग्य फ़ाइल के स्थान के सापेक्ष गणना किया जा सकता है, न कि उपयोगकर्ता की वर्तमान कार्यशील निर्देशिका के लिए।
  
  
  कोड

  import os
  from alembic.config import CommandLine, Config
  from pathlib import Path
  
  
  PROJECT_PATH = Path(__file__).parent.parent.resolve()
  
  
  def main():
      alembic = CommandLine()
      options = alembic.parser.parse_args()
  
      #     (alembic.ini),   
      #    
      if not os.path.isabs(options.config):
          options.config = os.path.join(PROJECT_PATH, options.config)
  
      #    Alembic
      config = Config(file_=options.config, ini_section=options.name,
                      cmd_opts=options)
  
      #      alembic   (,  alembic
      #   env.py,       )
      alembic_location = config.get_main_option('script_location')
      if not os.path.isabs(alembic_location):
          config.set_main_option('script_location',
                                 os.path.join(PROJECT_PATH, alembic_location))
  
      #   alembic
      exit(alembic.run_cmd(config, options))
  
  
  if __name__ == '__main__':
      main()

from setuptools import setup

setup(..., entry_points={
    'console_scripts': [
        'analyzer-db = analyzer.db.__main__:main'
    ]
})

$ pip install -e '.[dev]'

हम पलायन पैदा करते हैं

$ make postgres
...
$ analyzer-db revision --message="Initial" --autogenerate
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.autogenerate.compare] Detected added table 'imports'
INFO  [alembic.autogenerate.compare] Detected added table 'citizens'
INFO  [alembic.autogenerate.compare] Detected added index 'ix__citizens__town' on '['town']'
INFO  [alembic.autogenerate.compare] Detected added table 'relations'
  Generating /Users/alvassin/Work/backendschool2019/analyzer/db/alembic/versions/d5f704ed4610_initial.py ...  done

• बनाए गए तालिकाओं में निर्दिष्ट उपयोगकर्ता डेटा प्रकार स्वचालित रूप से (हमारे मामले में - gender) बनाए जाते हैं , लेकिन उन्हें हटाने का कोड downgradeउत्पन्न नहीं होता है। यदि आप लागू करते हैं, तो वापस रोल करें, और फिर माइग्रेशन फिर से लागू करें, इससे एक त्रुटि होगी क्योंकि निर्दिष्ट डेटा प्रकार पहले से मौजूद है।
  
  
  लिंग डेटा प्रकार को डाउनग्रेड पद्धति में हटाएं

  from alembic import op
  from sqlalchemy import Column, Enum
  
  GenderType = Enum('female', 'male', name='gender')
  
  
  def upgrade():
      ...
      #      GenderType   
      op.create_table('citizens', ...,
                      Column('gender', GenderType, nullable=False))
      ...
  
  
  def downgrade():
      op.drop_table('citizens')
  
      #       
      GenderType.drop(op.get_bind())

• विधि में, downgradeकुछ क्रियाओं को कभी-कभी हटाया जा सकता है (यदि हम पूरी तालिका को हटा देते हैं, तो आप इसके अनुक्रमित को अलग से नहीं हटा सकते):
  
  
  उदाहरण के लिए

  def downgrade():
  op.drop_table('relations')
  
  #      citizens,    
  #    
  op.drop_index(op.f('ix__citizens__town'), table_name='citizens')
  op.drop_table('citizens')
  op.drop_table('imports')

$ analyzer-db upgrade head
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade  -> d5f704ed4610, Initial

आवेदन

import logging

from aiohttp import web


def main():
    #  
    logging.basicConfig(level=logging.DEBUG)

    #  
    app = web.Application()

    #  
    app.router.add_route(...)

    #  
    web.run_app(app)

• एप्लिकेशन को कैसे कॉन्फ़िगर करें? कम से कम, आपको क्लाइंट से कनेक्ट करने के लिए होस्ट और पोर्ट को निर्दिष्ट करना होगा, साथ ही डेटाबेस से कनेक्ट करने के लिए जानकारी भी।
  
  मुझे वास्तव में मॉड्यूल की मदद से इस समस्या को हल करना पसंद है ConfigArgParse: यह मानक एक का विस्तार करता है argparseऔर कॉन्फ़िगरेशन के लिए कमांड लाइन तर्क, पर्यावरण चर (डॉकटर कंटेनरों को कॉन्फ़िगर करने के लिए अपरिहार्य) और यहां तक ​​कि कॉन्फ़िगरेशन फ़ाइलों (साथ ही इन विधियों को मिलाकर) का उपयोग करने की अनुमति देता है। ConfigArgParseइसका उपयोग करके , आप एप्लिकेशन कॉन्फ़िगरेशन मापदंडों के मूल्यों को भी मान्य कर सकते हैं।
  
  
  ConfigArgParse का उपयोग करके प्रसंस्करण मापदंडों का एक उदाहरण

  from aiohttp import web
  from configargparse import ArgumentParser, ArgumentDefaultsHelpFormatter
  
  from analyzer.utils.argparse import positive_int
  
  parser = ArgumentParser(
      #        ANALYZER_,
      #  ANALYZER_API_ADDRESS  ANALYZER_API_PORT
      auto_env_var_prefix='ANALYZER_',
  
      #     
      formatter_class=ArgumentDefaultsHelpFormatter
  )
  
  parser.add_argument('--api-address', default='0.0.0.0',
                      help='IPv4/IPv6 address API server would listen on')
  
  #      
  parser.add_argument('--api-port', type=positive_int, default=8081,
                      help='TCP port API server would listen on')
  
  
  def main():
      #   ,     
      #  ,    
      args = parser.parse_args()
  
      #       
      app = web.Application()
      web.run_app(app, host=args.api_address, port=args.api_port)
  
  
  if __name__ == '__main__':
      main()

  
  , ConfigArgParse, argparse, ( -h --help). :
  
  

  $ python __main__.py --help
  usage: __main__.py [-h] [--api-address API_ADDRESS] [--api-port API_PORT]
  
  If an arg is specified in more than one place, then commandline values override environment variables which override defaults.
  
  optional arguments:
    -h, --help            show this help message and exit
    --api-address API_ADDRESS
                          IPv4/IPv6 address API server would listen on [env var: ANALYZER_API_ADDRESS] (default: 0.0.0.0)
    --api-port API_PORT   TCP port API server would listen on [env var: ANALYZER_API_PORT] (default: 8081)

• — , «» . , .
  
  os.environ.clear(), Python (, asyncio?), , ConfigArgParser.
  
  

  import os
  from typing import Callable
  from configargparse import ArgumentParser
  from yarl import URL
  
  from analyzer.api.app import create_app
  from analyzer.utils.pg import DEFAULT_PG_URL
  
  ENV_VAR_PREFIX = 'ANALYZER_'
  
  parser = ArgumentParser(auto_env_var_prefix=ENV_VAR_PREFIX)
  parser.add_argument('--pg-url', type=URL, default=URL(DEFAULT_PG_URL),
                     help='URL to use to connect to the database')
  
  
  def clear_environ(rule: Callable):
      """
        ,     
       rule
      """
      #   os.environ    tuple,    
      # os.environ   
      for name in filter(rule, tuple(os.environ)):
          os.environ.pop(name)
  
  
  def main():
      #  
      args = parser.parse_args()
  
      #      ANALYZER_
      clear_environ(lambda i: i.startswith(ENV_VAR_PREFIX))
  
      #  
      app = create_app(args)
      ...
  
  
  if __name__ == '__main__':
      main()

• stderr/ .
  
  9 , logging.basicConfig() stderr.
  
  , . aiomisc.
  
  
  aiomisc

  import logging
  
  from aiomisc.log import basic_config
  
  basic_config(logging.DEBUG, buffered=True)    
  

• , ? , fork , (, Windows ).
  
  

  import os
  from sys import argv
  
  import forklib
  from aiohttp.web import Application, run_app
  from aiomisc import bind_socket
  from setproctitle import setproctitle
  
  
  def main():
      sock = bind_socket(address='0.0.0.0', port=8081, proto_name='http')
      setproctitle(f'[Master] {os.path.basename(argv[0])}')
  
      def worker():
          setproctitle(f'[Worker] {os.path.basename(argv[0])}')
          app = Application()
          run_app(app, sock=sock)
  
      forklib.fork(os.cpu_count(), worker, auto_restart=True)
  
  
  if __name__ == '__main__':
      main()
  

• - ? , ( — ) , nobody. — .
  
  

  import os
  import pwd
  
  from aiohttp.web import run_app
  from aiomisc import bind_socket
  
  from analyzer.api.app import create_app
  
  
  def main():
      #  
      sock = bind_socket(address='0.0.0.0', port=8085, proto_name='http')
  
      user = pwd.getpwnam('nobody')
      os.setgid(user.pw_gid)
      os.setuid(user.pw_uid)
  
      app = create_app(...)
      run_app(app, sock=sock)
  
  
  if __name__ == '__main__':
      main()

• create_app, .

from aiohttp.web import Application, View, run_app
from aiohttp.web_response import json_response


class SomeView(View):
    async def get(self):
        return json_response({'hello': 'world'})


app = Application()
app.router.add_route('*', '/hello', SomeView)
run_app(app)

from types import MappingProxyType
from typing import Mapping

from aiohttp import PAYLOAD_REGISTRY, JsonPayload
from aiohttp.web import run_app, Application, Response, View

PAYLOAD_REGISTRY.register(JsonPayload, (Mapping, MappingProxyType))


class SomeView(View):
    async def get(self):
        return Response(body={'hello': 'world'})


app = Application()
app.router.add_route('*', '/hello', SomeView)
run_app(app)

import json
from datetime import date
from functools import partial, singledispatch
from typing import Any

from aiohttp.payload import JsonPayload as BaseJsonPayload
from aiohttp.typedefs import JSONEncoder

@singledispatch
def convert(value):
    raise NotImplementedError(f'Unserializable value: {value!r}')


@convert.register(Record)
def convert_asyncpg_record(value: Record):
    """
        , 
    asyncpg
    """
    return dict(value)


@convert.register(date)
def convert_date(value: date):
    """
       date      —  
      .     
      ..
    """
    return value.strftime('%d.%m.%Y')
    
 
dumps = partial(json.dumps, default=convert)


class JsonPayload(BaseJsonPayload):
    def __init__(self,
                 value: Any,
                 encoding: str = 'utf-8',
                 content_type: str = 'application/json',
                 dumps: JSONEncoder = dumps,
                 *args: Any,
                 **kwargs: Any) -> None:
        super().__init__(value, encoding, content_type, dumps, *args, **kwargs)

हैंडलर

from aiohttp.web_urldispatcher import View
from asyncpgsa import PG


class BaseView(View):
    URL_PATH: str

    @property
    def pg(self) -> PG:
        return self.request.app['pg']

पोस्ट / आयात

• डेटा प्रकार, प्रारूप और सभी आवश्यक क्षेत्रों की उपलब्धता;
• अपरिचित खेतों की कमी;
• जन्म की तारीख को प्रारूप में इंगित किया जाना चाहिए DD.MM.YYYYऔर भविष्य से इसका कोई महत्व नहीं हो सकता है;
• प्रत्येक निवासी के रिश्तेदारों की सूची में इस अपलोड में मौजूद निवासियों के अनन्य पहचानकर्ता होने चाहिए।

• citizen_id उतराई के भीतर प्रत्येक निवासी अद्वितीय होना चाहिए;
• पारिवारिक संबंध दो-तरफ़ा होने चाहिए (यदि निवासी # 1 का संबंधियों की सूची में निवासी # 2 है, तो निवासी # 2 का भी एक रिश्तेदार # 1 होना चाहिए)।

GET / आयात / $ import_id / नागरिक

from aiohttp.web_exceptions import HTTPNotFound
from sqlalchemy import select, exists

from analyzer.db.schema import imports_table


class BaseImportView(BaseView):
    @property
    def import_id(self):
        return int(self.request.match_info.get('import_id'))

    async def check_import_exists(self):
        query = select([
            exists().where(imports_table.c.import_id == self.import_id)
        ])
        if not await self.pg.fetchval(query):
            raise HTTPNotFound()

1. एक SelectQueryप्रकार की वस्तु AsyncIterableजो डेटाबेस से रिकॉर्ड लौटाती है। पहली कॉल पर, यह डेटाबेस से जुड़ता है, एक ट्रांजेक्शन खोलता है और एक कर्सर बनाता है; आगे के पुनरावृत्ति के दौरान, यह डेटाबेस से रिकॉर्ड लौटाता है। इसे हैंडलर ने लौटा दिया है।
   
   
   SelectQuery कोड

   from collections import AsyncIterable
   from asyncpgsa.transactionmanager import ConnectionTransactionContextManager
   from sqlalchemy.sql import Select
   
   
   class SelectQuery(AsyncIterable):
       """
       ,     PostgreSQL   
       ,  ,    
       """
       PREFETCH = 500
   
       __slots__ = (
           'query', 'transaction_ctx', 'prefetch', 'timeout'
       )
   
       def __init__(self, query: Select,
                    transaction_ctx: ConnectionTransactionContextManager,
                    prefetch: int = None,
                    timeout: float = None):
           self.query = query
           self.transaction_ctx = transaction_ctx
           self.prefetch = prefetch or self.PREFETCH
           self.timeout = timeout
   
       async def __aiter__(self):
           async with self.transaction_ctx as conn:
               cursor = conn.cursor(self.query, prefetch=self.prefetch,
                                    timeout=self.timeout)
               async for row in cursor:
                   yield row
   

2. एक धारावाहिक AsyncGenJSONListPayloadजो अतुल्यकालिक जनरेटर पर पुनरावृति कर सकता है, एक अतुल्यकालिक जनरेटर से JSON के डेटा को क्रमबद्ध करता है और भागों में ग्राहकों को डेटा भेजता है। यह aiohttp.PAYLOAD_REGISTRYवस्तुओं के एक धारावाहिक के रूप में पंजीकृत है AsyncIterable।
   
   
   AsyncGenJSONListPayload कोड

   import json
   from functools import partial
   
   from aiohttp import Payload
   
   
   # ,    JSON  asyncpg.Record  datetime.date
   dumps = partial(json.dumps, default=convert, ensure_ascii=False)
   
   
   class AsyncGenJSONListPayload(Payload):
       """
          AsyncIterable,     
        JSON   
       """
       def __init__(self, value, encoding: str = 'utf-8',
                    content_type: str = 'application/json',
                    root_object: str = 'data',
                    *args, **kwargs):
           self.root_object = root_object
           super().__init__(value, content_type=content_type, encoding=encoding,
                            *args, **kwargs)
   
       async def write(self, writer):
           #  
           await writer.write(
               ('{"%s":[' % self.root_object).encode(self._encoding)
           )
   
           first = True
           async for row in self._value:
               #      
               if not first:
                   await writer.write(b',')
               else:
                   first = False
   
               await writer.write(dumps(row).encode(self._encoding))
   
           #  
           await writer.write(b']}')

# analyzer/api/handlers/citizens.py
from aiohttp.web_response import Response
from aiohttp_apispec import docs, response_schema

from analyzer.api.schema import CitizensResponseSchema
from analyzer.db.schema import citizens_table as citizens_t
from analyzer.utils.pg import SelectQuery

from .query import CITIZENS_QUERY
from .base import BaseImportView


class CitizensView(BaseImportView):
    URL_PATH = r'/imports/{import_id:\d+}/citizens'

    @docs(summary='    ')
    @response_schema(CitizensResponseSchema())
    async def get(self):
        await self.check_import_exists()

        query = CITIZENS_QUERY.where(
            citizens_t.c.import_id == self.import_id
        )
        body = SelectQuery(query, self.pg.transaction())
        return Response(body=body)

PATCH / आयात / $ import_id / नागरिक / $ Cit_id

• निर्दिष्ट फ़ील्ड के लिए डेटा का प्रकार और प्रारूप।
• जन्म की तारीख। इसे एक प्रारूप में निर्दिष्ट किया जाना चाहिए DD.MM.YYYYऔर भविष्य से इसका महत्व नहीं हो सकता है।
• प्रत्येक निवासी के रिश्तेदारों की एक सूची। इसमें निवासियों के लिए विशिष्ट पहचानकर्ता होने चाहिए।

GET / आयात / $ import_id / नागरिक / जन्मदिन

1. डेटाबेस से रिश्तेदारों के साथ निवासियों के लिए डेटा प्राप्त करें, और पायथन पक्ष पर, महीने के अनुसार डेटा एकत्र करें और उन महीनों के लिए सूचियां बनाएं जिनके लिए डेटाबेस में कोई डेटा नहीं है।
2. डेटाबेस में एक json अनुरोध संकलित करें और लापता महीनों के लिए स्टब्स जोड़ें।

GET / आयात / $ import_id / कस्बों / स्टेट / प्रतिशत / आयु

1. डेटाबेस से निवासियों की आयु प्राप्त करें, शहर द्वारा समूहीकृत, और फिर पायथन की ओर से खसरे का उपयोग करके प्रतिशत की गणना करें (जो कार्य में एक संदर्भ के रूप में निर्दिष्ट है) और दो दशमलव स्थानों तक गोल।
2. PostgreSQL: percentile_cont , SQL-, numpy .

परिक्षण

import os
import uuid

import pytest
from sqlalchemy import create_engine
from sqlalchemy_utils import create_database, drop_database
from yarl import URL

from analyzer.utils.pg import DEFAULT_PG_URL

PG_URL = os.getenv('CI_ANALYZER_PG_URL', DEFAULT_PG_URL)


@pytest.fixture
def postgres():
    tmp_name = '.'.join([uuid.uuid4().hex, 'pytest'])
    tmp_url = str(URL(PG_URL).with_path(tmp_name))
    create_database(tmp_url)

    try:
        #      postgres  -
        yield tmp_url
    finally:
        drop_database(tmp_url)


def test_db(postgres):
    """
     ,  PostgreSQL
    """
    engine = create_engine(postgres)
    assert engine.execute('SELECT 1').scalar() == 1
    engine.dispose()

from types import SimpleNamespace

import pytest

from analyzer.utils.pg import make_alembic_config


@pytest.fixture()
def alembic_config(postgres):
    cmd_options = SimpleNamespace(config='alembic.ini', name='alembic',
                                  pg_url=postgres, raiseerr=False, x=None)
    return make_alembic_config(cmd_options)

हैंडलर

from alembic.command import upgrade

@pytest.fixture
async def migrated_postgres(alembic_config, postgres):
    upgrade(alembic_config, 'head')
    #  DSN  ,    
    return postgres

@pytest.fixture
def arguments(aiomisc_unused_port, migrated_postgres):
    return parser.parse_args(
        [
            '--log-level=debug',
            '--api-address=127.0.0.1',
            f'--api-port={aiomisc_unused_port}',
            f'--pg-url={migrated_postgres}'
        ]
    )

from analyzer.api.app import create_app

@pytest.fixture
async def api_client(aiohttp_client, arguments):
    app = create_app(arguments)
    client = await aiohttp_client(app, server_kwargs={
        'port': arguments.api_port
    })

    try:
        yield client
    finally:
        await client.close()

1. postgres ( migrated_postgres).
2. alembic_config Alembic, ( migrated_postgres).
3. migrated_postgres ( arguments).
4. aiomisc_unused_port ( arguments).
5. arguments ( api_client).
6. api_client .
7. .
8. api_client .
9. postgres .

GET / आयात / $ import_id / नागरिक

• कई रिश्तेदारों के साथ उतारना। जाँच करता है कि प्रत्येक निवासी के लिए रिश्तेदारों के पहचानकर्ताओं के साथ एक सूची सही ढंग से बनाई जाएगी।
• रिश्तेदारों के बिना एक निवासी के साथ उतारना। जाँचता है कि फ़ील्ड relativesएक खाली सूची है ( LEFT JOINSQL क्वेरी के कारण , रिश्तेदारों की सूची बराबर हो सकती है [None])।
• एक निवासी के साथ उतारना जो स्वयं का रिश्तेदार है।
• खाली उतारना। जाँचता है कि हैंडलर खाली उतराई जोड़ने की अनुमति देता है और एक त्रुटि के साथ दुर्घटना नहीं करता है।

import pytest

from analyzer.utils.testing import generate_citizen

datasets = [
    #    
    [
        generate_citizen(citizen_id=1, relatives=[2, 3]),
        generate_citizen(citizen_id=2, relatives=[1]),
        generate_citizen(citizen_id=3, relatives=[1])
    ],

    #   
    [
        generate_citizen(relatives=[])
    ],

    #   ,    
    [
        generate_citizen(citizen_id=1, name='', gender='male',
                         birth_date='17.02.2020', relatives=[1])
    ],

    #  
    [],
]


@pytest.mark.parametrize('dataset', datasets)
async def test_get_citizens(api_client, dataset):
    """
        4 ,    
    """

from typing import Iterable, Mapping

def normalize_citizen(citizen):
    """
         
    """
    return {**citizen, 'relatives': sorted(citizen['relatives'])}


def compare_citizens(left: Mapping, right: Mapping) -> bool:
    """
      
    """
    return normalize_citizen(left) == normalize_citizen(right)


def compare_citizen_groups(left: Iterable, right: Iterable) -> bool:
    """
          ,   
      
    """
    left = [normalize_citizen(citizen) for citizen in left]
    left.sort(key=lambda citizen: citizen['citizen_id'])

    right = [normalize_citizen(citizen) for citizen in right]
    right.sort(key=lambda citizen: citizen['citizen_id'])
    return left == right

पोस्ट / आयात

• सही डेटा, डेटाबेस से सफलतापूर्वक जोड़े जाने की उम्मीद है।
  
  
  • ( ).
    
    . , , insert , .
  • ( , ).
    
    , .
    
  • .
    
    , . :)
    
  • 
    
    , aiohttp PostgreSQL 32 767 ( ).
    
  • खाली उतारना
    
    हैंडलर को ऐसे मामले को ध्यान में रखना चाहिए और गिरना नहीं चाहिए, निवासियों के साथ तालिका में खाली सम्मिलित प्रदर्शन करने की कोशिश करनी चाहिए।
    
  
  
• त्रुटियों के साथ डेटा, 400 की HTTP प्रतिक्रिया की अपेक्षा करें: खराब अनुरोध।
  
  
  • जन्म की तारीख गलत है (भविष्य काल)।
  • नागरिक_ अपलोड के भीतर अद्वितीय नहीं है।
  • रिश्तेदारी को गलत तरीके से इंगित किया जाता है (केवल एक निवासी से दूसरे व्यक्ति के लिए है, लेकिन कोई प्रतिक्रिया नहीं है)।
  • उतराई में निवासी का अस्तित्वहीन रिश्तेदार है।
  • पारिवारिक संबंध अद्वितीय नहीं हैं।

PATCH / आयात / $ import_id / नागरिक / $ Cit_id

• फ़ील्ड निर्दिष्ट है, लेकिन एक गलत डेटा प्रकार और / या प्रारूप है
• जन्म की तारीख गलत है (भविष्य का समय)।
• फ़ील्ड relativesमें एक रिश्तेदार होता है जो उतराई में मौजूद नहीं होता है।

GET / आयात / $ import_id / नागरिक / जन्मदिन

• एक उतराई जिसमें एक निवासी एक महीने में एक रिश्तेदार और दूसरे में दो रिश्तेदार होते हैं।
• रिश्तेदारों के बिना एक निवासी के साथ उतारना। जाँच करता है कि हैंडलर गणना में इसे ध्यान में नहीं रखता है।
• खाली उतारना। जाँच करता है कि हैंडलर विफल नहीं होगा और प्रतिक्रिया में 12 महीनों के साथ सही शब्दकोश लौटाएगा।
• एक निवासी के साथ उतारना जो स्वयं का रिश्तेदार है। जाँच करता है कि एक निवासी अपने जन्म के महीने के लिए एक उपहार खरीदेगा।

GET / आयात / $ import_id / कस्बों / स्टेट / प्रतिशत / आयु

from unittest.mock import patch

import pytz

CURRENT_DATE = datetime(2020, 2, 17, tzinfo=pytz.utc)


@patch('analyzer.api.handlers.TownAgeStatView.CURRENT_DATE', new=CURRENT_DATE)
async def test_get_ages(...):
    ...

• कई निवासियों के साथ उतारना जिनका जन्मदिन कल है (उम्र - कई साल और 364 दिन)। जाँचता है कि प्रोसेसर गणना में पूरे वर्ष की संख्या का उपयोग करता है।
• एक निवासी के साथ उतारना जिसका जन्मदिन आज है (उम्र - ठीक कुछ साल)। यह क्षेत्रीय मामले की जांच करता है - एक निवासी की उम्र जिसका आज जन्मदिन है, उसकी गणना 1 वर्ष से कम नहीं होनी चाहिए।
• खाली उतारना। हैंडलर उस पर नहीं गिरना चाहिए।

# Python 3
round(2.5)
> 2

-- PostgreSQL
SELECT ROUND(2.5)
> 3

import pytz

from analyzer.utils.testing import generate_citizen


CURRENT_DATE = datetime(2020, 2, 17, tzinfo=pytz.utc)

def age2date(years: int, days: int = 0, base_date=CURRENT_DATE) -> str:
    birth_date = copy(base_date).replace(year=base_date.year - years)
    birth_date -= timedelta(days=days)
    return birth_date.strftime(BIRTH_DATE_FORMAT)

#    ?  ,     ?
generate_citizen(birth_date='17.02.2009')

#   11       
generate_citizen(birth_date=age2date(years=11))

एक दिलचस्प तथ्य: जब मैंने 29 फरवरी, 2020 को यह परीक्षण लिखा था, तो मैंने अचानक फ़ेकर में बग के कारण निवासियों के साथ अनलोड करना बंद कर दिया (2020 एक लीप ईयर है, और अन्य वर्ष जो फ़ेकर ने चुने थे, उनमें हमेशा लीप वर्ष नहीं थे। 29 फरवरी को नहीं था)। याद रखें कि तारीखें रिकॉर्ड करें और किनारे के मामलों का परीक्षण करें!

माइग्रेशन

• downgrade ( , , ).
  
  , (--): , — .
  
• C .
• ( ).

सभा

1. एक "भारी" छवि snakepacker/python:all(~ 1 जीबी, ~ 500 एमबी संपीड़ित) का उपयोग करके, एक आभासी वातावरण बनाएं, सभी निर्भरताएं और उस पर एप्लिकेशन पैकेज स्थापित करें। यह छवि विशेष रूप से विधानसभा के लिए आवश्यक है, इसमें एक संकलक, सभी आवश्यक लाइब्रेरी और हेडर के साथ फाइलें हो सकती हैं।
   
   

   FROM snakepacker/python:all as builder
   
   #   
   RUN python3.8 -m venv /usr/share/python3/app
   
   #  source distribution     
   COPY dist/ /mnt/dist/
   RUN /usr/share/python3/app/bin/pip install /mnt/dist/*

2. हम समाप्त आभासी वातावरण को एक "प्रकाश" छवि snakepacker/python:3.8(~ 100 एमबी, संपीड़ित ~ 50 एमबी) में कॉपी करते हैं , जिसमें केवल पायथन के आवश्यक संस्करण का दुभाषिया होता है।
   
   महत्वपूर्ण: एक आभासी वातावरण में, निरपेक्ष पथ का उपयोग किया जाता है, इसलिए इसे उसी पते पर कॉपी किया जाना चाहिए जिस पर यह कलेक्टर कंटेनर में इकट्ठा किया गया था।
   
   

   FROM snakepacker/python:3.8 as api
   
   #       builder
   COPY --from=builder /usr/share/python3/app /usr/share/python3/app
   
   #  ,     
   # 
   RUN ln -snf /usr/share/python3/app/bin/analyzer-* /usr/local/bin/
   
   #        
   CMD ["analyzer-api"]

###############      ################
#  — «» (~1 ,    ~500 )    
#    
FROM snakepacker/python:all as builder

#      pip
RUN python3.8 -m venv /usr/share/python3/app
RUN /usr/share/python3/app/bin/pip install -U pip

#   ,  .   
# Docker   ,  requirements.txt  
COPY requirements.txt /mnt/
RUN /usr/share/python3/app/bin/pip install -Ur /mnt/requirements.txt

#  source distribution     
COPY dist/ /mnt/dist/
RUN /usr/share/python3/app/bin/pip install /mnt/dist/* \
    && /usr/share/python3/app/bin/pip check

###########################   ############################
#    «» (~100 ,    ~50 )   Python
FROM snakepacker/python:3.8 as api

#         builder
COPY --from=builder /usr/share/python3/app /usr/share/python3/app

#  ,     
# 
RUN ln -snf /usr/share/python3/app/bin/analyzer-* /usr/local/bin/

#        
CMD ["analyzer-api"]

Ci

name: CI

# Workflow      
#   -  master
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  #       workflow
  test:
    runs-on: ubuntu-latest

    services:
      postgres:
        image: docker://postgres
        ports:
          - 5432:5432
        env:
          POSTGRES_USER: user
          POSTGRES_PASSWORD: hackme
          POSTGRES_DB: analyzer

    steps:
      - uses: actions/checkout@v2
      - name: test
        uses: docker://snakepacker/python:all
        env:
          CI_ANALYZER_PG_URL: postgresql://user:hackme@postgres/analyzer
        with:
          args: /bin/bash -c "pip install -U '.[dev]' && pylama && wait-for-port postgres:5432 && pytest -vv --cov=analyzer --cov-report=term-missing tests"

  #    Docker-  
  publish:
    #        master
    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
    # ,   test   
    needs: test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: sdist
        uses: docker://snakepacker/python:all
        with:
          args: make sdist

      - name: build-push
        uses: docker/build-push-action@v1
        with:
          username: ${{ secrets.REGISTRY_LOGIN }}
          password: ${{ secrets.REGISTRY_TOKEN }}
          repository: alvassin/backendschool2019
          target: api
          tags: 0.0.1, latest

तैनाती

[Unit]
Description=%i service with docker compose
Requires=docker.service
After=docker.service

[Service]
Type=oneshot
RemainAfterExit=true
WorkingDirectory=/etc/docker/compose/%i
ExecStart=/usr/local/bin/docker-compose up -d --remove-orphans
ExecStop=/usr/local/bin/docker-compose down

[Install]
WantedBy=multi-user.target

---

- name: Gathering facts
  hosts: all
  become: yes
  gather_facts: yes

- name: Install docker
  hosts: docker
  become: yes
  gather_facts: no
  roles:
    - docker

- name: Install analyzer
  hosts: api
  become: yes
  gather_facts: no
  roles:
    - analyzer

[api]
130.193.51.154

[docker:children]
api

[api:vars]
analyzer_image = alvassin/backendschool2019
analyzer_pg_user = user
analyzer_pg_password = hackme
analyzer_pg_dbname = analyzer

$ ansible-playbook -i hosts.ini deploy.yml

तनाव परीक्षण के बारे में

, , . , - . : , — , 10 . , (, , CI-): .

, , , 10 . ? , , . , , .

RPS, : . , , import_id, POST /imports . .

, Python 3, Locust.

, locustfile.py locust. - .

Locust . , .
self.round .

locustfile.py

# locustfile.py
import logging
from http import HTTPStatus

from locust import HttpLocust, constant, task, TaskSet
from locust.exception import RescheduleTask

from analyzer.api.handlers import (
    CitizenBirthdaysView, CitizensView, CitizenView, TownAgeStatView
)
from analyzer.utils.testing import generate_citizen, generate_citizens, url_for


class AnalyzerTaskSet(TaskSet):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.round = 0

    def make_dataset(self):
        citizens = [
            #     .   
            # PATCH-  relatives    
            # ,     - 
            # (     ,    
            # ).
            generate_citizen(citizen_id=1, relatives=[2]),
            generate_citizen(citizen_id=2, relatives=[1]),
            *generate_citizens(citizens_num=9998, relations_num=1000,
                               start_citizen_id=3)
        ]
        return {citizen['citizen_id']: citizen for citizen in citizens}

    def request(self, method, path, expected_status, **kwargs):
        with self.client.request(
                method, path, catch_response=True, **kwargs
        ) as resp:
            if resp.status_code != expected_status:
                resp.failure(f'expected status {expected_status}, '
                             f'got {resp.status_code}')
            logging.info(
                'round %r: %s %s, http status %d (expected %d), took %rs',
                self.round, method, path, resp.status_code, expected_status,
                resp.elapsed.total_seconds()
            )
            return resp

    def create_import(self, dataset):
        resp = self.request('POST', '/imports', HTTPStatus.CREATED,
                            json={'citizens': list(dataset.values())})
        if resp.status_code != HTTPStatus.CREATED:
            raise RescheduleTask
        return resp.json()['data']['import_id']

    def get_citizens(self, import_id):
        url = url_for(CitizensView.URL_PATH, import_id=import_id)
        self.request('GET', url, HTTPStatus.OK,
                     name='/imports/{import_id}/citizens')

    def update_citizen(self, import_id):
        url = url_for(CitizenView.URL_PATH, import_id=import_id, citizen_id=1)
        self.request('PATCH', url, HTTPStatus.OK,
                     name='/imports/{import_id}/citizens/{citizen_id}',
                     json={'relatives': [i for i in range(3, 10)]})

    def get_birthdays(self, import_id):
        url = url_for(CitizenBirthdaysView.URL_PATH, import_id=import_id)
        self.request('GET', url, HTTPStatus.OK,
                     name='/imports/{import_id}/citizens/birthdays')

    def get_town_stats(self, import_id):
        url = url_for(TownAgeStatView.URL_PATH, import_id=import_id)
        self.request('GET', url, HTTPStatus.OK,
                     name='/imports/{import_id}/towns/stat/percentile/age')

    @task
    def workflow(self):
        self.round += 1
        dataset = self.make_dataset()

        import_id = self.create_import(dataset)
        self.get_citizens(import_id)
        self.update_citizen(import_id)
        self.get_birthdays(import_id)
        self.get_town_stats(import_id)


class WebsiteUser(HttpLocust):
    task_set = AnalyzerTaskSet
    wait_time = constant(1)

100 c , , :



, ( — 95 , — ). .



— Ansible ~20.15 ~20.30 Locust.

और क्या किया जा सकता है?

* * *

स्वीकृतियाँ