Python과 Bash의 우정 만들기: smart-env 및 python-shell 라이브러리

모두에게 좋은 하루 되세요.

오늘날 Python은 소프트웨어 제품 자체를 만드는 것뿐만 아니라 인프라를 제공하는 분야에서 가장 많이 사용되는 언어 중 하나입니다. 결과적으로, 많은 개발자들은 자신의 의지에 의해서든 반대하든 나중에 좋은 오래된 Bash 스크립트를 보완하기 위해 새로운 언어를 배워야 했습니다. 그러나 Bash와 Python은 코드 작성에 대한 서로 다른 접근 방식을 공언하고 특정 기능을 가지고 있습니다. 즉, Bash 스크립트를 "뱀 언어"로 포팅하는 것은 때로는 방대하고 사소한 작업이 아닙니다.

DevOps의 삶을 더 쉽게 만들기 위해 Python의 유용한 라이브러리와 유틸리티가 많이 만들어졌고 계속해서 만들어지고 있습니다. 이 기사에서는 이 게시물의 작성자가 만든 두 개의 새로운 라이브러리에 대해 설명합니다. 스마트 환경 и 파이썬 쉘 - 개발자가 Python 작업의 복잡성에 많은 주의를 기울일 필요가 없도록 설계하여 더 흥미로운 작업을 위한 여지를 남겨두었습니다. 라이브러리의 활동 범위는 환경 변수와 외부 유틸리티 실행입니다.

관심 있는 분들은 고양이를 만나보세요.

새로운 "자전거"?

상당히 일반적인 작업을 위해 새 패키지를 만드는 이유는 무엇일까요? os.environ 및 subprocess.<선택한 메서드 또는 클래스>를 직접 사용하지 못하게 하는 이유는 무엇입니까?

각 도서관에 유리한 증거를 별도로 제공하겠습니다.

스마트 환경 라이브러리

자신만의 아이디어를 작성하기 전에 온라인에 접속하여 기성 솔루션을 찾는 것이 유용합니다. 물론 필요한 것을 찾지 못할 위험이 있지만 이는 오히려 "보험 이벤트"입니다. 일반적으로 이 접근 방식은 효과적이며 많은 시간과 노력을 절약해 줍니다.

결과에 따르면 검색 엔진 다음이 밝혀졌습니다.

• 실제로 os.environ에 대한 호출을 래핑하는 패키지가 있지만 동시에 여러 가지 방해적인 작업(클래스 인스턴스 생성, 호출의 특수 매개 변수 등)이 필요합니다.
• 그러나 특정 생태계(주로 Django와 같은 웹 프레임워크)에 엄격하게 묶여 있으므로 파일 없이는 전혀 보편적이지 않은 좋은 패키지가 있습니다.
• 새로운 것을 시도하는 경우는 거의 없습니다. 예를 들어, 입력 추가 다음과 같은 메소드를 호출하여 변수 값을 명시적으로 구문 분석합니다.

  get_<typename>(var_name)

  또는 여기 또 다른 해결책, 그러나 현재 불명예스러운 Python 2를 지원하지 않습니다. 공식 RIP, 작성된 코드와 전체 생태계는 여전히 산더미처럼 많습니다.

• 알 수 없는 이유로 인해 업스트림 PyPI에 들어가고 새 패키지 이름 지정에만 문제를 일으키는 학교-학생 기술이 있습니다(특히 "smart-env"라는 이름은 필수 조치입니다).

그리고 이 목록은 오랫동안 지속될 수 있습니다. 하지만 위의 점들은 뭔가 편리하고 보편적인 것을 만든다는 생각에 설렘을 주기에 충분했습니다.

smart-env를 작성하기 전에 설정된 요구사항:

• 가장 간단한 사용 방식
• 쉽게 구성 가능한 데이터 입력 지원
• Python 2.7 호환
• 테스트를 통한 우수한 코드 적용 범위

결국 이 모든 것이 실현되었습니다. 다음은 사용 예입니다.

from smart_env import ENV

print(ENV.HOME)  # Equals print(os.environ['HOME'])

# assuming you set env variable MYVAR to "True"

ENV.enable_automatic_type_cast()

my_var = ENV.MY_VAR  # Equals boolean True

ENV.NEW_VAR = 100  # Sets a new environment variable

예제에서 볼 수 있듯이, 새 클래스로 작업하려면 해당 클래스를 가져오기만 하면 됩니다(인스턴스를 만들 필요가 없습니다 - 추가 작업 제외). 모든 환경 변수에 대한 액세스는 이를 ENV 클래스의 변수로 참조하여 달성됩니다. 이는 실제로 이 클래스를 기본 시스템 환경에 대한 직관적인 래퍼로 만드는 동시에 거의 모든 시스템에 대해 가능한 구성 개체로 전환합니다( 예를 들어 비슷한 접근 방식이 Django에서 달성됩니다. 여기서 구성 개체는 설정 모듈/패키지 자체입니다.

자동 입력 지원 모드를 활성화/비활성화하는 방법은 두 가지 방법(enable_automatic_type_cast() 및 비활성화_automatic_type_cast())을 사용하여 수행됩니다. 이는 환경 변수에 직렬화된 JSON과 같은 객체 또는 부울 상수만 포함되어 있는 경우 편리할 수 있습니다(환경 변수를 "유효한" 문자열과 비교하여 Django에서 DEBUG 변수를 명시적으로 설정하는 것이 가장 일반적인 경우 중 하나입니다). 그러나 이제 문자열을 명시적으로 변환할 필요가 없습니다. 필요한 작업의 대부분은 이미 라이브러리 깊이에 포함되어 있으며 신호가 작동하기를 기다리고 있습니다. 🙂 일반적으로 타이핑은 투명하게 작동하며 사용 가능한 거의 모든 내장 데이터 유형을 지원합니다(frozenset, complex 및 bytes는 테스트되지 않았습니다).

Python 2를 지원하기 위한 요구 사항은 특히 유비쿼터스 3(메타클래스 사용 문제를 해결하기 위해) 덕분에 사실상 희생(타이핑 포기 및 Python XNUMX 최신 버전의 일부 "사탕") 없이 구현되었습니다. ).

그러나 몇 가지 제한 사항이 있습니다.

• Python 3 지원은 버전 3.5 이상을 의미합니다(프로젝트에 Python 3.4이 존재하는 것은 게으르거나 개선이 필요하지 않은 결과입니다. 아직 XNUMX를 사용하는 객관적인 이유를 찾기가 어렵기 때문입니다).
• Python 2.7에서 라이브러리는 집합 리터럴의 역직렬화를 지원하지 않습니다. 설명 여기에. 하지만 구현하고 싶은 분이 계시다면 환영합니다 :);

라이브러리에는 구문 분석 오류가 발생할 경우 예외 메커니즘도 있습니다. 사용 가능한 어떤 분석기에서도 문자열을 인식할 수 없는 경우 값은 문자열로 유지됩니다(오히려 편의성과 Bash에서 변수가 작동하는 방식에 대한 일반적인 논리와의 하위 호환성을 이유로).

파이썬 쉘 라이브러리

이제 두 번째 라이브러리에 대해 설명하겠습니다. (기존 아날로그의 단점에 대한 설명은 생략하겠습니다. 이는 smart-env에 대해 설명한 것과 유사합니다. 아날로그 - 여기에 и 여기에).

일반적으로 구현 아이디어와 요구 사항은 예제에서 볼 수 있듯이 smart-env에 대해 설명된 것과 유사합니다.

from python_shell import Shell

Shell.ls('-l', '$HOME')  # Equals "ls -l $HOME"

command = Shell.whoami()  # Equals "whoami"
print(command.output)  # prints your current user name

print(command.command)  # prints "whoami"
print(command.return_code)  # prints "0"
print(command.arguments)  # prints ""

Shell.mkdir('-p', '/tmp/new_folder')  # makes a new folder

아이디어는 다음과 같습니다.

1. Python 세계에서 Bash를 나타내는 단일 클래스입니다.
2. 각 Bash 명령은 Shell 클래스의 함수로 호출됩니다.
3. 그런 다음 각 함수 호출에 대한 매개변수가 해당 Bash 명령 호출에 전달됩니다.
4. 각 명령은 호출되는 순간 "지금 여기"에서 실행됩니다. 동기식 접근 방식이 작동합니다.
5. stdout의 명령 출력과 해당 반환 코드에 액세스할 수 있습니다.
6. 명령이 시스템에 없으면 예외가 발생합니다.

smart-env와 마찬가지로 Python 2는 지원되지만(약간 더 많은 희생이 필요함) Python 3.0-3.4는 지원되지 않습니다.

도서관 개발 계획

이제 라이브러리를 사용할 수 있습니다. 둘 다 공식 PyPI에 게시되어 있습니다. 소스는 Github에서 확인할 수 있습니다(아래 참조).

두 라이브러리 모두 관심 있는 사람들로부터 수집된 피드백을 고려하여 개발될 것입니다. 그리고 smart-env에서 다양한 새로운 기능을 생각해내는 것이 어려울 수 있다면 python-shell에는 확실히 추가할 다른 것이 있습니다:

• 비차단 통화 지원;
• 팀과의 대화식 의사소통 가능성(stdin을 사용하여 작업)
• 새 속성 추가(예: stderr에서 출력을 수신하는 속성)
• 사용 가능한 명령 디렉토리 구현(dir() 함수와 함께 사용)
• 기타

참조

1. 스마트 환경 라이브러리: 깃허브 и PyPI
2. 파이썬 쉘 라이브러리: 깃허브 и PyPI
3. 전보 채널 도서관 업데이트

업데이트 23.02.2020:
* 저장소가 이동되었으며 해당 링크가 업데이트되었습니다.
* python-shell==1.0.1 버전은 29.02.2020년 XNUMX월 XNUMX일 출시를 위해 준비 중입니다. 변경 사항에는 명령 자동 완성 및 dir(Shell) 명령 지원, 잘못된 Python 식별자로 명령 실행 및 버그 수정이 포함됩니다.

출처 : habr.com