validit

유효합니다

구성 파일 구조를 쉽게 정의하고 템플릿을 사용하여 파일을 확인하십시오. ?

• 설치
  • 추가 파일 형식에 대한 지원
• 용법
  • 템플릿 정의
  • 데이터 검증
    • 파일에서 데이터 검증
• ValidIT를 종속성으로 사용합니다

설치

ValidIT는 Cpython 3.6, 3.7, 3.8 및 3.9에서 테스트됩니다. PIP를 사용하여 설치하기 만하면됩니다.

$ (sudo) pip install validit

추가 파일 형식에 대한 지원

기본적으로 ValidIT는 JSON 구성 파일 만 지원하거나 이미로드 된 데이터 만 지원합니다 (구성 파일에서 직접 제외). 그러나 추가 종속성을 사용하면 다음 파일 형식이 지원 됩니다.

• JSON
• YAML
• TOML

선호하는 파일 형식을 지원하기 위해 추가로 필요한 종속성으로 ValidIT를 설치하려면 다음을 사용하십시오.

 pip install validit[yaml]        # install dependencies for yaml files
pip install validit[toml]        # toml files
pip install validit[json,toml]   # json and toml files
pip install validit[all]         # all available file formats 

용법

템플릿 정의

템플릿을 만들려면 기본 Template 모듈과 일반적으로 다른 세 가지 기본 모듈 TemplateList , TemplateDict 및 Optional 필요합니다.

다음 예에서는 단일 사용자를 나타내는 기본 템플릿을 만듭니다.

 from validit import Template , TemplateList , TemplateDict , Optional

TemplateUser = TemplateDict (            # a dictionary with 2 required values
    username = Template ( str ),             # username must be a string
    passcode = Template ( int , str ),        # can be a string or an integer.
    nickname = Optional ( Template ( str )),   # optional - if provided, must be a string.
)

데이터 검증

템플릿으로 데이터를 확인하려면 Validate 객체를 사용해야합니다.

 from validit import Template , TemplateDict , Optional , Validate

template = TemplateDict (
    username = Template ( str ),
    passcode = Template ( int , str ),
    nickname = Optional ( Template ( str )),
)

data = {
    'username' : 'RealA10N' ,
    'passcode' : 123 ,
}

valid = Validate ( template , data )
if valid . errors :            # if one or more errors found
    print ( valid . errors )     # print errors to console
    exit ( 1 )                 # exit the script with exit code 1

else :                       # if data matches the template
    run_script ( valid . data )  # run the script with the loaded data 

파일에서 데이터 검증

데이터가 파일에 저장된 경우 ValidateFromJSON , ValidateFromYAML 또는 ValidateFromTOML objects를 대신 사용할 수 있습니다.

 from validit import Template , TemplateDict , Optional , ValidateFromYAML

filepath = '/path/to/data.yaml'
template = TemplateDict (
    username = Template ( str ),
    passcode = Template ( int , str ),
    nickname = Optional ( Template ( str )),
)

with open ( filepath , 'r' ) as file :
    # load and validate data from the file
    valid = ValidateFromYAML ( file , template )
    
if valid . errors :            # if one or more errors found
    print ( valid . errors )     # print errors to console
    exit ( 1 )                 # exit the script with exit code 1

else :                       # if data matches the template
    run_script ( valid . data )  # run the script with the loaded data 

ValidIT를 종속성으로 사용합니다

ValidIT는 여전히 활발한 개발 중이며 일부 핵심 기능은 가까운 시일 내에 실질적으로 변경 될 수 있습니다.

ValidIT를 프로젝트의 종속성으로 사용하려는 경우 requirements.txt 파일 또는 setup.py 스크립트에서 사용중인 모듈의 정확한 버전을 지정하는 것이 좋습니다.

예를 들어, 버전 v1.3.2를 찾으려면 requirements.txt 에서 다음 줄을 사용하십시오 .txt 파일 :

 validit==1.3.2
validit[yaml]==1.3.2     # If using extra file formats