Static Analysis 규칙

개요

Datadog Static Analysis는 코드 리뷰에서 CI/CD 파이프라인의 위반 사항을 감지하고, 버그, 보안, 유지 관리 문제를 식별하는데 도움이 되는 즉시 사용 가능한 규칙을 제공합니다. 자세한 정보는 Static Analysis 설명서를 참조하세요.

규칙

모범 사례를 따라 Python 코드 작성하기

규칙 세트 ID: python-best-practices

효율적이고 버그 없는 코드를 작성하기 위한 Python 모범 사례.

읽을 수 있는 클래스 이름 정하기AMBIGUOUS-CLASS-NAME 읽을 수 있는 함수 이름 정하기AMBIGUOUS-FUNCTION-NAME 읽을 수 있는 변수 이름 정하기AMBIGUOUS-VARIABLE-NAME any 유형 사용하지 않기ANY-TYPE-DISALLOW 같은 이름의 인수가 없도록 하기ARGUMENT-SAME-NAME assertraises는 특정 예외를 확인해야 함ASSERTRAISES-SPECIFIC-EXCEPTION 사전에서 중복 키 피하기AVOID-DUPLICATE-KEYS 문자열 연결 피하기AVOID-STRING-CONCAT 클래스 메서드는 self를 사용할 수 없음CLASS-METHODS-USE-SELF 반복하는 동안 사전 수정하지 않기COLLECTION-WHILE-ITERATING todo 및 fixme 코멘트는 소유권이 있어야 함COMMENT-FIXME-TODO-OWNERSHIP 비교에서 변수는 그대로 두어야 함COMPARISON-CONSTANT-LEFT if 조건은 다른 코드 블록이어야 함CONDITION-SIMILAR-BLOCK __exit__와 __enter__가 모두 정의되었는지 확인CTX-MANAGER-ENTER-EXIT-DEFINED 데이터 클래스에 특수 메서드 사용하지 않기DATACLASS-SPECIAL-METHODS check equal은 일관된 기본 유형에 사용됨EQUAL-BASIC-TYPES 예외가 기본 예외를 상속하는지 확인EXCEPTION-INHERIT finally 블록에서 break나 continue 사용하지 않기FINALLY-NO-BREAK-CONTINUE-RETURN 함수는 한 번만 정의해야 함FUNCTION-ALREADY-EXISTS 함수 인수에 할당하지 않아야 함FUNCTION-VARIABLE-ARGUMENT-NAME 제네릭 예외를 사용하는 경우 마지막에 두어야 함GENERIC-EXCEPTION-LAST getter/setter는 각각 한 개 또는 두 개의 인수를 가져야 함GET-SET-ARGUMENTS if 조건이 값을 반환하는 경우 else는 필요하지 않음IF-RETURN-NO-ELSE 모듈을 두 번 가져옴IMPORT-MODULES-TWICE import statement 당 하나의 모듈만 가져옴IMPORT-SINGLE-MODULE super()를 사용하여 상위 생성자 호출하기INIT-CALL-PARENT 클래스에 __init__ 메서드가 있는지 확인하기INIT-METHOD-REQUIRED __init__ 함수로 반환하지 않음INIT-NO-RETURN-VALUE strip() 인수에 중복 문자가 없어야 함INVALID-STRIP-CALL 로깅 함수에 형식 문자열 사용하지 않기LOGGING-NO-FORMAT 메서드가 속성과 같은 이름을 가짐METHOD-HIDDEN 너무 많은 중첩된 블록을 갖지 않기NESTED-BLOCKS 프로덕션 코드에 assert 사용하지 않기NO-ASSERT 튜플에 assert 사용하지 않기NO-ASSERT-ON-TUPLES bare except 사용하지 않기NO-BARE-EXCEPT 특별한 예외가 없는 한 raise 스테이트먼트는 사용하지 않기NO-BARE-RAISE 기본 예외를 발생시키지 않기NO-BASE-EXCEPTION datetime.today() 사용하지 않기NO-DATETIME-TODAY 이중 부정 사용하지 않기NO-DOUBLE-NOT 연산자 --와 ++ 사용하지 않기NO-DOUBLE-UNARY-OPERATOR 기본 클래스는 한 번만 사용하기NO-DUPLICATE-BASE-CLASS 연산자 =+와 =- 사용하지 않기NO-EQUAL-UNARY exit() 사용하지 않기NO-EXIT 제네릭 예외 사용하지 않기NO-GENERIC-EXCEPTION 조건에서 true와 비교하지 않기NO-IF-TRUE range(len(<array>))에서 for i 사용하지 않기NO-RANGE-LOOP-WITH-LEN 패스 스테이트먼트가 있는 예외 무시하지 않기NO-SILENT-EXCEPTION 읽기 전용에서는 오픈 플래그 정의하지 않기OPEN-ADD-FLAG os.environ에 할당해도 환경은 지워지지 않음OS-ENVIRON-NO-ASSIGN notimplemented를 발생시키지 말 것 - 존재하지 않음RAISING-NOT-IMPLEMENTED __bytes__ 메서드는 문자열이 아니라 바이트를 반환해야 함RETURN-BYTES-NOT-STRING 함수 외부로 반환하지 않기RETURN-OUTSIDE-FUNCTION 자신에게 할당하지 않기SELF-ASSIGNMENT __slots__가 단일 문자열이어서는 안 됨SLOTS-NO-SINGLE-STRING 특수 메서드에 올바른 인수가 있는지 확인하기SPECIAL-METHODS-ARGUMENTS 정적 메서드에 파라미터로 self 사용하지 않기STATIC-METHOD-NO-SELF 중첩된 if 조건을 너무 많이 사용하지 않기TOO-MANY-NESTED-IF 중첩된 루프 및 조건을 너무 많이 사용하지 않기TOO-MANY-WHILE type 대신 isinstance 사용하기TYPE-CHECK-ISINSTANCE 도달할 수 없는 코드 피하기UNREACHABLE-CODE 값이 호출 가능한지 알아보기 위해 hasattr 사용하지 않기USE-CALLABLE-NOT-HASATTR

Python 코드 스타일 적용

규칙 세트 ID: python-code-style

Python 코드 스타일을 적용하는 규칙

변수 이름은 snake_case이어야 함ASSIGNMENT-NAMES 클래스 이름은 카멜 케이스여야함CLASS-NAME 함수 이름과 파라미터에 반드시 snake_case 사용하기FUNCTION-NAMING 클래스는 100 줄 미만이어야 함MAX-CLASS-LINES 함수는 200줄 미만이어야 함MAX-FUNCTION-LINES

Python 프로그램 구조 확인

규칙 세트 ID: python-design

중첩된 루프를 포함한 Python 프로그램의 구조 확인을 위한 규칙.

함수는 100줄 미만이어야 함FUNCTION-TOO-LONG

Django 모범 사례 및 보안 확인

규칙 세트 ID: python-django

Django 모범 사례와 보안을 위한 규칙.

json 데이터를 전송할 때 httpresponse 대신 jsonresponse 사용하기HTTP-RESPONSE-WITH-JSON-DUMPS jsonresponse에서 content-type 지정하지 않기JSONRESPONSE-NO-CONTENT-TYPE charfield에 대해 항상 max_length 지정하기MODEL-CHARFIELD-MAX-LENGTH 모델 열을 문서화할 때 help_text 사용하기MODEL-HELP-TEXT nullbooleanfield 사용하지 않기NO-NULL-BOOLEAN __unicode__ 사용하지 않기NO-UNICODE-ON-MODELS 가능한 한 convenience imports 사용하기USE-CONVENIENCE-IMPORTS

Flask 모범 사례 및 보안 확인

규칙 세트 ID: python-flask

Flask 모범 사례와 보안을 위한 규칙.

json 출력에 json.dumps 대신 jsonify 사용하기USE-JSONIFY

Python 코드에 표현 문제가 있는지 확인

규칙 세트 ID: python-inclusive

Python의 코드와 주석에서 부적절한 표현을 피하기 위한 규칙.

코멘트에 표현 문제가 있는지 확인하기COMMENTS 함수 이름에 표현 문제가 있는지 확인하기FUNCTION-DEFINITION 변수 이름에 표현 문제가 있는지 확인하기VARIABLE-NAME

pandas를 사용한 데이터 과학 모범 사례

규칙 세트 ID: python-pandas

pandas 코드가 적절하게 사용되었는지 확인하기 위한 일련의 규칙입니다.

• import 선언이 다음 코딩 가이드라인을 따르도록 합니다.
• 더 이상 사용되지 않는 코드와 메서드를 피하세요.
• 가능한 한 비효율적인 코드를 피하세요.

함수 대신 산술 연산자 사용하기ARITH-OPERATOR-NOT-FUNCTIONS inplace=true 사용하지 않기AVOID-INPLACE 값을 비교하기 위해 함수가 아닌 연산자 사용하기COMP-OPERATOR-NOT-FUNCTION 코딩 가이드라인에 따라 판다스 가져오기IMPORT-AS-PD isnull 대신 isna 사용하기ISNA-INSTEAD-OF-ISNULL ix 보다는 iloc 또는 loc 사용하기LOC-NOT-IX notnull 보다는 notna 사용하기NOTNA-INSTEAD-OF-NOTNULL pivot 또는 unstack 대신 pivot_table 사용하기PIVOT-TABLE read_table 보다는 read_csv 사용하기USE-READ-CSV-NOT-READ-TABLE

참고 자료

Additional helpful documentation, links, and articles:

Datadog Static Analysis에 대해 알아보기설명서