Coverage for lynceus/core/config/__init__.py: 100%

1# Defines various constants. 

2 

3# * Date/time format 

4DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%f%z" 

5DATETIME_FORMAT_SHORT = "%Y-%m-%d" 

6 

7# * Internals constants (avoiding circular import). 

8LYNCEUS_S3_CONFIG_KEY: str = 'lynceus_s3_config' 

9 

10# * Configuration instance 

11CONFIG_GENERAL_KEY: str = 'General' 

12 

13# Constants definition for 'Processing' configuration level: where any process can store information // used by jobs to share info. 

14CONFIG_PROCESS_KEY: str = 'Processing' 

15CONFIG_RUN_EXECUTION_ID: str = 'execution_id' 

16 

17CONFIG_PROJECT_REPO_ANALYSE_DIR: str = 'uncompress_repo_directory' 

18 

19CONFIG_PROCESS_REPO_ALL_FILE: str = 'interesting_files_list' 

20CONFIG_PROCESS_REPO_FILE_COUNT: str = 'interesting_files_count' 

21 

22CONFIG_PROCESS_REPO_LINES_COUNT: str = 'interesting_lines_count' 

23 

24# Constants definition for 'Storage' configuration level: where user can configure some directory to work into (like temporary root directory). 

25CONFIG_STORAGE_KEY: str = 'StorageConfiguration' 

26 

27CONFIG_STORAGE_REMOTE_TYPE: str = 'storage_type' 

28CONFIG_STORAGE_LOCAL: str = 'Local' 

29 

30CONFIG_STORAGE_IS_DYNAMIC: str = 'is_dynamic' 

31CONFIG_STORAGE_DYNAMIC_TYPE: str = 'dynamic_type' 

32CONFIG_STORAGE_REMOTE_AVAILABLE: str = 'available_remote_storages' 

33CONFIG_STORAGE_REMOTE_CONF_FILE: str = 'remote_storages_conf' 

34 

35# Lynceus client (API, CLI ...) related config. 

36# * configuration option 

37CONFIG_JSON_DUMP_KEY_END_KEYWORD: str = '_json_dump' 

38CONFIG_AUTHENTICATION_KEY: str = 'Authentication' 

39 

40CONFIG_PARTICIPANT_EMAIL: str = 'participant_email' 

41CONFIG_SCORE_PARTICIPANT: str = 'score_participant' 

42CONFIG_DISCRIMINANT: str = 'discriminant' 

43CONFIG_PROGRAM_ID: str = 'program_id' 

44 

45# - other parameters related to logging 

46CONFIG_LOG_MESSAGE_STATUS_KEY: str = 'message_status' 

47 

48# * various constants 

49 

50 

51# Constants definition for 'Jobs' configuration level: configuration of jobs. 

52CONFIG_JOBS_KEY: str = 'Jobs' 

53CONFIG_JOBS_DISABLED_LIST: str = 'disabled_job_list' 

54 

55# Constants definition for 'Project' configuration level: configuration of project to analyze. 

56CONFIG_PROJECT_KEY: str = 'Project' 

57CONFIG_PROJECT_URI: str = 'uri' 

58CONFIG_PROJECT_NAME: str = 'name' 

59CONFIG_PROJECT_PATH: str = 'project_path' 

60 

61CONFIG_PROJECT_CRED_SECRET: str = 'credential_secret' 

62CONFIG_PROJECT_CRED_SECRET_GITLAB_DEFAULT: str = 'gitlab_default_credential_secret' 

63CONFIG_PROJECT_CRED_SECRET_GITHUB_DEFAULT: str = 'github_default_credential_secret' 

64 

65CONFIG_PROJECT_ROOT_PATH_HOLDER: str = '<PROJECT_ROOT_PATH>' 

66 

67# Constants definition for 'Project profile metadata' configuration level: project profile metadata. 

68 

69 

70# * Job metadata definition. 

71# Job metadata keys. 

72 

73 

74# Job categories. 

75 

76 

77# * Scoring metadata definition. 

78 

79 

80# * Various configuration 

81# Constants definition for structure meta. 

82 

83 

84# CONFIG_STRUCTURE_CHECK_ALL_VALUES constant is interesting for Lynceus API to automatically remove any possible message prefix 

85# when creating message with status. 

86 

87 

88GOOD_BAD_STRING: dict[bool, str] = { 

89 

90} 

91 

92FOUND_OR_NOT_STRING: dict[bool, str] = { 

93 

94} 

95 

96# * Compute Resources related constants. 

97ACCESS_PERMISSION_RO: str = 'RO' 

98ACCESS_PERMISSION_RW: str = 'RW' 

99ACCESS_PERMISSION_RWD: str = 'RWD' 

100 

101# Keyword used when creating some computing resources. 

102CREATED_OBJECT_NAME_KEYWORD: str = 'aitraining'