콘텐츠로 이동
@aws/nx-plugin
Blog

Python 프로젝트

Python 프로젝트 생성기는 모범 사례로 구성된 최신 Python 라이브러리 또는 애플리케이션을 생성하는 데 사용할 수 있습니다. UV로 관리되며, UV 워크스페이스에서 단일 잠금 파일과 가상 환경을 사용하고, 테스트 실행을 위한 pytest, 정적 분석을 위한 Ruff, 타입 검사를 위한 ty가 구성되어 있습니다.

사용법

섹션 제목: “사용법”

Python 프로젝트 생성

섹션 제목: “Python 프로젝트 생성”

두 가지 방법으로 새 Python 프로젝트를 생성할 수 있습니다:

이 제너레이터 실행@aws/nx-plugin:py#project

pnpm nx g @aws/nx-plugin:py#project
명령 구성하기6

필수

필수

어떤 파일이 변경될지 확인하기 위해 드라이 런을 수행할 수도 있습니다

옵션

섹션 제목: “옵션”
제너레이터 옵션6 옵션
name필수string

Python 프로젝트의 이름

type필수enum기본값: application

프로젝트가 애플리케이션인지 라이브러리인지 여부

applicationlibrary
directorystring기본값: packages

프로젝트가 배치될 상위 디렉토리

subDirectorystring

프로젝트가 배치되는 하위 디렉토리입니다. 기본값은 프로젝트 이름입니다.

moduleNamestring

Python 모듈 이름

preferInstallDependenciesboolean기본값: true

생성기 실행 후 의존성 설치를 선호할지 여부입니다. 여러 생성기를 일괄 처리할 때 설치를 연기하려면 false로 설정하세요 (후속 생성기가 Nx 프로젝트 그래프를 계산할 수 있도록 필요한 경우 설치는 여전히 실행됩니다); 마지막에 한 번만 설치합니다.

생성기 출력

섹션 제목: “생성기 출력”

생성기는 <directory>/<name> 디렉터리에 다음과 같은 프로젝트 구조를 생성합니다:

  • 디렉터리<module-name>
    • __init__.py Module initialisation
  • 디렉터리tests
    • __init__.py Module initialisation
    • conftest.py Test configuration
    • test_noop.py Placeholder test
  • project.json Project configuration and build targets
  • pyproject.toml Packaging configuration file used by UV
  • .python-version Contains the project’s Python version

워크스페이스 루트에 다음 파일들이 생성/업데이트되는 것을 확인할 수 있습니다:

  • pyproject.toml Workspace level packaging configuration for UV
  • .python-version Contains the workspace Python version
  • uv.lock Lockfile for Python dependencies

Python 소스 코드 작성

섹션 제목: “Python 소스 코드 작성”

<module-name> 디렉터리에 Python 소스 코드를 추가하세요.

다른 프로젝트에서 라이브러리 코드 가져오기

섹션 제목: “다른 프로젝트에서 라이브러리 코드 가져오기”

add 타겟을 사용하여 Python 프로젝트에 의존성을 추가하세요.

my_app과 my_lib라는 두 개의 Python 프로젝트를 생성했다고 가정해 봅시다. 이들은 각각 my_scope.my_app과 my_scope.my_lib라는 완전한 프로젝트 이름을 가지며, 기본적으로 각각 my_scope_my_app과 my_scope_my_lib라는 모듈 이름을 갖습니다.

my_app이 my_lib에 의존하도록 하려면 다음 명령을 실행할 수 있습니다:

Terminal window
pnpm nx run my_scope.my_app:add my_scope.my_lib

그런 다음 라이브러리 코드를 가져올 수 있습니다:

packages/my_app/my_scope_my_app/main.py
from my_scope_my_lib.my_module import my_function

위에서 my_scope_my_lib는 라이브러리의 모듈 이름이고, my_module은 Python 소스 파일 my_module.py에 해당하며, my_function은 해당 파일에 정의된 메서드입니다.

의존성

섹션 제목: “의존성”

프로젝트에 의존성을 추가하려면 Python 프로젝트에서 add 타겟을 실행할 수 있습니다. 예를 들어:

Terminal window
pnpm nx run my_scope.my_library:add some-pip-package

이렇게 하면 프로젝트의 pyproject.toml 파일에 의존성이 추가되고 루트 uv.lock이 업데이트됩니다.

런타임 코드

섹션 제목: “런타임 코드”

Python 프로젝트를 런타임 코드로 사용할 때(예: AWS 람다 함수의 핸들러로), 소스 코드와 모든 의존성의 번들을 생성해야 합니다. py#lambda-function, py#api 및 py#mcp-server 생성기가 이를 자동으로 추가합니다. 수동으로 추가하려면 해당 생성기가 제공하는 형태와 일치하도록 project.json 파일에 다음과 같은 타겟을 추가하세요:

project.json
{
  "targets": {
    "bundle": {
      "dependsOn": ["bundle-x86"]
    },
    "bundle-x86": {
      "cache": true,
      "inputs": ["production", "^production"],
      "executor": "nx:run-commands",
      "outputs": ["{workspaceRoot}/dist/{projectRoot}/bundle-x86"],
      "options": {
        "commands": [
          "uv export --frozen --no-dev --no-editable --project {projectRoot} --package my_scope.my_library -o dist/{projectRoot}/bundle-x86/requirements.txt",
          "uv pip install -n --no-deps --no-installer-metadata --no-compile-bytecode --python-platform x86_64-manylinux_2_28 --python-version 3.14 --target dist/{projectRoot}/bundle-x86 -r dist/{projectRoot}/bundle-x86/requirements.txt"
        ],
        "parallel": false
      },
      "dependsOn": ["compile"]
    }
  }
}

설치

섹션 제목: “설치”

다음 명령으로 Python 의존성을 설치하세요:

터미널 창
uv sync

빌드

섹션 제목: “빌드”

Python 프로젝트는 build 타겟(project.json에 정의됨)으로 구성되어 있으며, 다음을 통해 실행할 수 있습니다:

Terminal window
pnpm nx build <project-name>

여기서 <project-name>은 프로젝트의 완전한 이름입니다.

build 타겟은 프로젝트를 컴파일, 린트, 테스트 및 타입 검사합니다.

빌드 출력은 워크스페이스의 루트 dist 폴더에서 찾을 수 있으며, 패키지 및 타겟에 대한 디렉터리 내부에 있습니다. 예: dist/packages/<my-library>/build

워크스페이스의 모든 프로젝트를 빌드하려면 다음을 실행하세요:

Terminal window
pnpm nx run-many --target build

또는 단축 명령을 사용하세요:

Terminal window
pnpm build

Assembling

섹션 제목: “Assembling”

프로젝트에는 assemble 타겟도 있으며, 이는 린트, 테스트 또는 타입 검사 게이트를 실행하지 않고 프로젝트가 배포에 기여하는 것(예: 컴파일되거나 번들된 출력)을 생성합니다.

Terminal window
pnpm nx assemble <project-name>

배포 타겟은 assemble에 의존하므로, 배포 시 배포할 내용만 빌드합니다.

테스트

섹션 제목: “테스트”

pytest가 프로젝트 테스트를 위해 구성되어 있습니다.

테스트 작성

섹션 제목: “테스트 작성”

테스트는 프로젝트 내의 tests 디렉터리에 작성해야 하며, test_ 접두사가 붙은 Python 파일에 작성합니다. 예를 들어:

  • 디렉터리my_library
    • my_module.py
  • 디렉터리tests
    • test_my_module.py Tests for my_module.py

테스트는 test_로 시작하는 메서드이며 기대값을 검증하기 위해 단언문을 만듭니다. 예를 들어:

tests/test_my_module.py
from my_library.my_module import say_hello


def test_say_hello():
  assert say_hello("Darth Vader") == "Hello, Darth Vader!"

테스트 작성 방법에 대한 자세한 내용은 pytest 문서를 참조하세요.

테스트 실행

섹션 제목: “테스트 실행”

테스트는 프로젝트의 build 타겟의 일부로 실행되지만, test 타겟을 실행하여 별도로 실행할 수도 있습니다:

Terminal window
pnpm nx test <project-name>

-k 플래그를 사용하여 테스트 파일 또는 메서드의 이름을 지정하여 개별 테스트 또는 테스트 모음을 실행할 수 있습니다:

Terminal window
pnpm nx test <project-name> -k 'test_say_hello'

테스트 파일 및 캐싱

섹션 제목: “테스트 파일 및 캐싱”

프로젝트의 tests 디렉터리는 nx.json의 production 명명된 입력에서 제외됩니다.

출력에 테스트 파일을 포함할 수 없는 타겟(예: compile 및 모든 번들 타겟)은 default 대신 production을 읽으므로, 테스트를 편집해도 해당 타겟이나 프로젝트에 의존하는 프로젝트의 작업이 무효화되지 않습니다.

제외는 의도적으로 tests 디렉터리로 제한됩니다. 패키지 디렉터리 내부의 test_*.py 파일은 빌드된 배포판에 패키징되므로 프로덕션 코드로 취급되며, 따라서 여전히 빌드를 무효화합니다.

test, lint, format 및 typecheck 타겟은 default를 읽으므로 테스트를 편집할 때 여전히 다시 실행됩니다. typecheck는 테스트도 타입 검사하므로 테스트의 타입 오류도 여전히 보고됩니다.

타입 검사

섹션 제목: “타입 검사”

Python 프로젝트는 타입 검사를 위해 ty를 사용합니다.

타입 검사기 실행

섹션 제목: “타입 검사기 실행”

타입 검사는 프로젝트의 build 타겟의 일부로 실행되지만, typecheck 타겟을 통해 별도로 실행할 수도 있습니다:

Terminal window
pnpm nx run <project-name>:typecheck

타입 오류 억제

섹션 제목: “타입 오류 억제”

단일 라인에 대한 특정 진단을 억제하려면 라인 끝에 # ty: ignore[<rule>] 주석을 추가하세요. 예를 들어:

value: int = "not an int"  # ty: ignore[invalid-assignment]

프로젝트 전체에서 타입 검사 동작을 구성하려면 프로젝트의 pyproject.toml에 [tool.ty] 섹션을 추가하세요. 사용 가능한 옵션은 ty 구성 참조를 참조하세요.

린트

섹션 제목: “린트”

Python 프로젝트는 린트를 위해 Ruff를 사용합니다.

린터 실행

섹션 제목: “린터 실행”

프로젝트를 검사하기 위해 린터를 호출하려면 lint 타겟을 실행할 수 있습니다.

Terminal window
pnpm nx lint <project-name>

린트 문제 수정

섹션 제목: “린트 문제 수정”

대부분의 린트 또는 포맷팅 문제는 자동으로 수정할 수 있습니다. --configuration=fix 인수를 사용하여 실행하면 Ruff가 린트 문제를 수정하도록 할 수 있습니다.

Terminal window
pnpm nx lint <project-name> --configuration=fix

마찬가지로 워크스페이스의 모든 패키지에서 모든 린트 문제를 수정하려면 다음을 실행할 수 있습니다:

Terminal window
pnpm nx run-many --target lint --all --configuration=fix

린트 문제 건너뛰기

섹션 제목: “린트 문제 건너뛰기”

개발 중에 린트 문제로 인해 속도가 느려지는 것을 방지하려면(특히 프로젝트에 자동 수정할 수 없는 문제가 있는 경우), skip-lint 구성으로 빌드를 실행할 수 있습니다:

Terminal window
pnpm nx run-many --target build --configuration=skip-lint

이렇게 하면 빌드의 일부로 Ruff가 여전히 실행되지만, 린트 타겟은 항상 성공한 것으로 간주됩니다.