Coverage for /opt/conda/envs/apienv/lib/python3.10/site-packages/daiquiri/core/options.py: 82%

1from typing import Optional, List 

2from pydantic import BaseModel, Field 

3 

4 

5def _dir_list(string) -> List[str]: 

6 """Returns a list of directories from a comma separater list""" 

7 folders = string.split(",") 

8 folders = [s.strip() for s in folders] 

9 return folders 

10 

11 

12class ServerOptions(BaseModel): 

13 """Options used to setup the Daiquiri server""" 

14 

15 resource_folders: Optional[List[str]] = Field( 

16 default=[], 

17 description="Server resources directories (first has priority)", 

18 json_schema_extra=dict(argparse_type=_dir_list), 

19 ) 

20 

21 static_folder: str = Field( 

22 default="static.default", 

23 description="Actor implementors module", 

24 ) 

25 

26 static_resources_folder: Optional[str] = Field( 

27 default=None, 

28 description="Extra folder to override `static_folder/resources`", 

29 json_schema_extra=dict(argparse_type=str), 

30 ) 

31 

32 hardware_folder: str = Field( 

33 default="", 

34 description="Hardware folder", 

35 ) 

36 

37 port: int = Field( 

38 default=8080, 

39 description="Web server port", 

40 json_schema_extra=dict(argparse_flag="-p"), 

41 ) 

42 

43 save_spec_file: Optional[str] = Field( 

44 default=None, 

45 description="If defined, save the current API spec into the specified file, and exit", 

46 json_schema_extra=dict( 

47 argparse_name="--save-spec", 

48 argparse_nargs="?", 

49 argparse_flag="-s", 

50 argparse_type=str, 

51 ), 

52 ) 

53 

54 implementors: Optional[str] = Field( 

55 default=None, 

56 description="Actor implementors module", 

57 json_schema_extra=dict(argparse_type=str), 

58 ) 

59 

60 ssl: Optional[bool] = Field( 

61 default=None, 

62 description="Enable the SSL protocol", 

63 json_schema_extra=dict(argparse_type=bool), 

64 ) 

65 

66 ssl_cert: Optional[str] = Field( 

67 default=None, 

68 description="Location of the SSL certificat", 

69 json_schema_extra=dict(argparse_type=str), 

70 ) 

71 

72 ssl_key: Optional[str] = Field( 

73 default=None, 

74 description="Location of the SSL key", 

75 json_schema_extra=dict(argparse_type=str), 

76 )