FilesExpand file tree

master

/

config_file.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

69 lines (55 loc) · 2.51 KB

master

/

config_file.py

Copy path

Top

File metadata and controls

• Code
• Blame

69 lines (55 loc) · 2.51 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

"""Module for configuring LanguageTool's local server."""

from typing import Any, Dict

import atexit

import os

import tempfile

# Allowed configuration keys for LanguageTool.

ALLOWED_CONFIG_KEYS = {

'maxTextLength', 'maxTextHardLength', 'maxCheckTimeMillis', 'maxErrorsPerWordRate',

'maxSpellingSuggestions', 'maxCheckThreads', 'cacheSize', 'cacheTTLSeconds', 'requestLimit',

'requestLimitInBytes', 'timeoutRequestLimit', 'requestLimitPeriodInSeconds', 'languageModel',

'fasttextModel', 'fasttextBinary', 'maxWorkQueueSize', 'rulesFile',

'blockedReferrers', 'premiumOnly', 'disabledRuleIds', 'pipelineCaching', 'maxPipelinePoolSize',

'pipelineExpireTimeInSeconds', 'pipelinePrewarming'

}

class LanguageToolConfig:

"""

Configuration class for LanguageTool.

:param config: Dictionary containing configuration keys and values.

:type config: Dict[str, Any]

Attributes:

config (Dict[str, Any]): Dictionary containing configuration keys and values.

path (str): Path to the temporary file storing the configuration.

"""

config: Dict[str, Any]

path: str

def __init__(self, config: Dict[str, Any]):

"""

Initialize the LanguageToolConfig object.

"""

assert set(config.keys()) <= ALLOWED_CONFIG_KEYS, f"unexpected keys in config: {set(config.keys()) - ALLOWED_CONFIG_KEYS}"

assert len(config), "config cannot be empty"

self.config = config

if 'disabledRuleIds' in self.config:

self.config['disabledRuleIds'] = ','.join(self.config['disabledRuleIds'])

if 'blockedReferrers' in self.config:

self.config['blockedReferrers'] = ','.join(self.config['blockedReferrers'])

for key in ["pipelineCaching", "premiumOnly", "pipelinePrewarming"]:

if key in self.config:

self.config[key] = str(bool(self.config[key])).lower()

self.path = self._create_temp_file()

def _create_temp_file(self) -> str:

"""

Create a temporary file to store the configuration.

:return: Path to the temporary file.

:rtype: str

"""

tmp_file = tempfile.NamedTemporaryFile(delete=False)

# Write key=value entries as lines in temporary file.

for key, value in self.config.items():

next_line = f'{key}={value}\n'

tmp_file.write(next_line.encode())

tmp_file.close()

# Remove file when program exits.

atexit.register(lambda: os.unlink(tmp_file.name))

return tmp_file.name