Debian Codegraph @

azure-kusto-data/azure/kusto/data/client_details.py

raw
1 import functools
2 import os
3 import re
4 import sys
5 from dataclasses import dataclass
6 from typing import List, Tuple, Optional
7
8 from .env_utils import get_env
9 from azure.kusto.data._version import VERSION
10
11 NONE = "[none]"
12
13 REPLACE_REGEX = re.compile(r"[\r\n\s{}|]+")
14
15
16 @functools.lru_cache(maxsize=1)
17 def default_script() -> str:
18 """Returns the name of the script that is currently running"""
19 try:
20 return os.path.basename(sys.argv[0]) or NONE
21 except Exception:
22 return NONE
23
24
25 @functools.lru_cache(maxsize=1)
26 def get_user_from_env() -> str:
27 user = get_env("USERNAME", optional=True)
28 domain = get_env("USERDOMAIN", optional=True)
29 if domain and user:
30 user = domain + "\\" + user
31 if user:
32 return user
33 return NONE
34
35
36 @functools.lru_cache(maxsize=1)
37 def default_user():
38 """Returns the name of the user that is currently logged in"""
39 try:
40 return os.getlogin() or get_user_from_env()
41 except Exception:
42 return get_user_from_env()
43
44
45 @functools.lru_cache(maxsize=1)
46 def format_version():
47 return format_header(
48 [
49 ("Kusto.Python.Client", VERSION),
50 (f"Runtime.{escape_field(sys.implementation.name)}", sys.version),
51 ]
52 )
53
54
55 def format_header(args: List[Tuple[str, str]]) -> str:
56 return "|".join(f"{key}:{escape_field(val)}" for (key, val) in args if key and val)
57
58
59 def escape_field(field: str):
60 return f"{{{REPLACE_REGEX.sub('_', field)}}}"
61
62
63 @dataclass
64 class ClientDetails:
65 application_for_tracing: str
66 user_name_for_tracing: str
67 version_for_tracing: str = format_version()
68
69 def __post_init__(self):
70 self.application_for_tracing = self.application_for_tracing or default_script()
71 self.user_name_for_tracing = self.user_name_for_tracing or default_user()
72
73 @staticmethod
74 def set_connector_details(
75 name: str,
76 version: str,
77 app_name: Optional[str] = None,
78 app_version: Optional[str] = None,
79 send_user: bool = False,
80 override_user: Optional[str] = None,
81 additional_fields: Optional[List[Tuple[str, str]]] = None,
82 ) -> "ClientDetails":
83 params = [("Kusto." + name, version)]
84
85 app_name = app_name or default_script()
86 app_version = app_version or NONE
87
88 params.append(("App." + escape_field(app_name), app_version))
89 params.extend(additional_fields or [])
90
91 user = NONE
92
93 if send_user:
94 user = override_user or default_user()
95
96 return ClientDetails(application_for_tracing=format_header(params), user_name_for_tracing=user)