ScriptCollection 4.3.24__py3-none-any.whl → 4.3.26__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -38,7 +38,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
38
38
  from .ProgramRunnerPopen import ProgramRunnerPopen
39
39
  from .SCLog import SCLog, LogLevel
40
40
 
41
- version = "4.3.24"
41
+ version = "4.3.26"
42
42
  __version__ = version
43
43
 
44
44
  class VSCodeWorkspaceShellTask:
@@ -152,6 +152,41 @@ class VSCodeWorkspaceMongoDBConnection:
152
152
  """
153
153
  return result
154
154
 
155
+ class GitHubIssueSummary:
156
+ number:int = None
157
+ title:str = None
158
+ state:str = None # "open" or "closed"
159
+ tags:list[str] = None # the labels of the issue
160
+
161
+ def __init__(self,number:int,title:str,state:str,tags:list[str]):
162
+ self.number=number
163
+ self.title=title
164
+ self.state=state
165
+ self.tags=tags
166
+
167
+
168
+ class GitHubIssueComment:
169
+ author:str = None #nullable
170
+ body:str = None
171
+ created_at:str = None #nullable
172
+
173
+ def __init__(self,author:str,body:str,created_at:str):
174
+ self.author=author
175
+ self.body=body
176
+ self.created_at=created_at
177
+
178
+
179
+ class GitHubIssue:
180
+ summary:GitHubIssueSummary = None
181
+ description:str = None #nullable (the body of the issue)
182
+ comments:list[GitHubIssueComment] = None
183
+
184
+ def __init__(self,summary:GitHubIssueSummary,description:str,comments:list[GitHubIssueComment]):
185
+ self.summary=summary
186
+ self.description=description
187
+ self.comments=comments
188
+
189
+
155
190
  class ScriptCollectionCore:
156
191
 
157
192
  # The purpose of this property is to use it when testing your code which uses scriptcollection for external program-calls.
@@ -165,6 +200,8 @@ class ScriptCollectionCore:
165
200
  log: SCLog = None
166
201
  # Magic string which can be used inside the arguments of run_command_in_folder. Every occurrence of it will be replaced by the (resolved) actual_folder.
167
202
  run_command_in_folder_actual_folder_placeholder: str = "{actual_folder}"
203
+ # Base-url of the GitHub-REST-API. This is an internal constant on purpose and deliberately not exposed as a parameter of the GitHub-functions.
204
+ __github_api_base_url: str = "https://api.github.com"
168
205
 
169
206
 
170
207
  def __init__(self):
@@ -314,6 +351,73 @@ class ScriptCollectionCore:
314
351
  self.run_program("docker",arg,arguments_for_log=arg_for_log,print_live_output=self.log.loglevel==LogLevel.Debug)
315
352
 
316
353
 
354
+ @GeneralUtilities.check_arguments
355
+ def get_issues_of_github_repository(self, owner: str, repository: str, github_token: str = None) -> list[GitHubIssueSummary]:
356
+ """Retrieves all issues (open and closed) of the given GitHub-repository and returns for each issue its number, title, state and tags.
357
+ Use 'get_github_issue_details' to retrieve the full details (description, comments) of a specific issue.
358
+ 'github_token' is optional but recommended: without it only public repositories are accessible and a low unauthenticated rate-limit applies.
359
+ This function only returns the retrieved data; it does not modify anything."""
360
+ headers = self.__get_github_api_headers(github_token)
361
+ result: list[GitHubIssueSummary] = []
362
+ issues_url = f"{self.__github_api_base_url}/repos/{owner}/{repository}/issues"
363
+ # 'state=all' returns open and closed issues. GitHub returns pull-requests on this endpoint too; they are filtered out below.
364
+ raw_issues = self.__get_all_github_pages(issues_url, {"state": "all", "per_page": "100"}, headers)
365
+ for raw_issue in raw_issues:
366
+ if "pull_request" in raw_issue: # this entry is a pull-request, not an issue
367
+ continue
368
+ tags = [label["name"] for label in raw_issue.get("labels", [])]
369
+ result.append(GitHubIssueSummary(raw_issue["number"], raw_issue["title"], raw_issue["state"], tags))
370
+ return result
371
+
372
+ @GeneralUtilities.check_arguments
373
+ def get_github_issue_details(self, owner: str, repository: str, issue_number: int, github_token: str = None) -> GitHubIssue:
374
+ """Retrieves the full details of a single issue of the given GitHub-repository:
375
+ title, description (body), comments, state ('open' or 'closed') and tags (labels).
376
+ 'github_token' is optional but recommended: without it only public repositories are accessible and a low unauthenticated rate-limit applies.
377
+ This function only returns the retrieved data; it does not modify anything."""
378
+ headers = self.__get_github_api_headers(github_token)
379
+ issue_url = f"{self.__github_api_base_url}/repos/{owner}/{repository}/issues/{issue_number}"
380
+ response = requests.get(issue_url, headers=headers, timeout=30)
381
+ response.raise_for_status() # check if statuscode = 200
382
+ raw_issue = response.json()
383
+ tags = [label["name"] for label in raw_issue.get("labels", [])]
384
+ summary = GitHubIssueSummary(raw_issue["number"], raw_issue["title"], raw_issue["state"], tags)
385
+ comments: list[GitHubIssueComment] = []
386
+ if raw_issue.get("comments", 0) > 0:
387
+ raw_comments = self.__get_all_github_pages(raw_issue["comments_url"], {"per_page": "100"}, headers)
388
+ for raw_comment in raw_comments:
389
+ author = raw_comment["user"]["login"] if raw_comment.get("user") is not None else None
390
+ comments.append(GitHubIssueComment(author, raw_comment.get("body"), raw_comment.get("created_at")))
391
+ return GitHubIssue(summary, raw_issue.get("body"), comments)
392
+
393
+ @GeneralUtilities.check_arguments
394
+ def __get_github_api_headers(self, github_token: str) -> dict:
395
+ headers = {"Accept": "application/vnd.github+json", "X-GitHub-Api-Version": "2022-11-28"}
396
+ if GeneralUtilities.string_has_content(github_token):
397
+ headers["Authorization"] = f"Bearer {github_token}"
398
+ return headers
399
+
400
+ @GeneralUtilities.check_arguments
401
+ def __get_all_github_pages(self, url: str, query_parameters: dict, headers: dict) -> list:
402
+ """Requests all pages of a paginated GitHub-API-endpoint (following the 'Link'-header) and returns the concatenated result-items."""
403
+ result: list = []
404
+ next_url = url
405
+ next_parameters = query_parameters
406
+ while next_url is not None:
407
+ response = requests.get(next_url, params=next_parameters, headers=headers, timeout=30)
408
+ response.raise_for_status() # check if statuscode = 200
409
+ result.extend(response.json())
410
+ # follow the pagination using the 'Link'-header ( https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api ).
411
+ next_url = None
412
+ next_parameters = None # the 'next'-url from the Link-header already contains all required query-parameters
413
+ link_header = response.headers.get("Link")
414
+ if link_header is not None:
415
+ for link in link_header.split(","):
416
+ parts = link.split(";")
417
+ if len(parts) >= 2 and 'rel="next"' in parts[1]:
418
+ next_url = parts[0].strip().lstrip("<").rstrip(">")
419
+ return result
420
+
317
421
  @GeneralUtilities.check_arguments
318
422
  def python_file_has_errors(self, file: str, working_directory: str, treat_warnings_as_errors: bool = True, display_file: str = None) -> tuple[bool, list[str]]:
319
423
  errors = list()
@@ -541,8 +541,8 @@ class TFCPS_CodeUnitSpecific_DotNet_Functions(TFCPS_CodeUnitSpecific_Base):
541
541
  return result
542
542
 
543
543
  @GeneralUtilities.check_arguments
544
- def generate_reference(self) -> None:
545
- self.generate_reference_using_docfx()
544
+ def generate_reference(self, generate_class_reference:bool=False) -> None:
545
+ self.generate_reference_using_docfx(generate_class_reference)
546
546
 
547
547
 
548
548
  @GeneralUtilities.check_arguments
@@ -5,6 +5,7 @@ import re
5
5
  import json
6
6
  import argparse
7
7
  from abc import ABC, abstractmethod
8
+ import yaml
8
9
  import xmlschema
9
10
  from packaging.version import Version
10
11
  from lxml import etree
@@ -247,8 +248,13 @@ class TFCPS_CodeUnitSpecific_Base(ABC):
247
248
 
248
249
 
249
250
  @GeneralUtilities.check_arguments
250
- def generate_reference_using_docfx(self):
251
+ def generate_reference_using_docfx(self, generate_class_reference:bool=False):
251
252
  reference_folder =os.path.join( self.get_codeunit_folder(),"Other","Reference")
253
+ class_reference_folder:str=os.path.join(reference_folder,"ReferenceContent","API")
254
+ toc_md_file:str=os.path.join(class_reference_folder,"toc.md")
255
+ GeneralUtilities.ensure_file_does_not_exist(toc_md_file)#should not be available when docfx is runninng because then toc.html will be generated from toc.md but toc.html will be generated by docfx in the target-folder
256
+
257
+ self.tfcps_Tools_General.generate_svg_files_from_plantuml_files_for_codeunit(self.get_codeunit_folder(), self.use_cache())
252
258
  generated_reference_folder = GeneralUtilities.resolve_relative_path("../Artifacts/Reference", reference_folder)
253
259
  GeneralUtilities.ensure_directory_does_not_exist(generated_reference_folder)
254
260
  GeneralUtilities.ensure_directory_exists(generated_reference_folder)
@@ -257,6 +263,46 @@ class TFCPS_CodeUnitSpecific_Base(ABC):
257
263
  self._protected_sc.run_program("docfx", "-t default,templates/darkfx docfx.json", reference_folder)
258
264
  GeneralUtilities.ensure_directory_does_not_exist(obj_folder)
259
265
 
266
+ if generate_class_reference:# this codeunit has a class-reference, so a human-readable table-of-content can be generated for it
267
+ GeneralUtilities.ensure_file_exists(toc_md_file)
268
+ GeneralUtilities.write_text_to_file(toc_md_file, self.__generate_toc_md_file_content(os.path.join(class_reference_folder,"toc.yml")))
269
+
270
+ @staticmethod
271
+ @GeneralUtilities.check_arguments
272
+ def __generate_toc_md_file_content(toc_file:str)->str:
273
+ """Generates the content of a markdown-table-of-content which contains a headline and links to the sub-files of the class-reference
274
+ based on the given toc.yml-file which was generated by docfx."""
275
+ toc_file_content = yaml.safe_load(GeneralUtilities.read_text_from_file(toc_file))
276
+ namespaces:list = list()
277
+ if isinstance(toc_file_content, dict):
278
+ namespaces = toc_file_content.get("items", list())
279
+ elif isinstance(toc_file_content, list):# older docfx-versions do not wrap the entries in an "items"-property
280
+ namespaces = toc_file_content
281
+ lines:list[str] = ["# Table of contents"]
282
+ for namespace in namespaces:
283
+ lines.append(GeneralUtilities.empty_string)
284
+ lines.append(f"## {TFCPS_CodeUnitSpecific_Base.__get_toc_entry_name(namespace)}")
285
+ lines.append(GeneralUtilities.empty_string)
286
+ entries:list = namespace.get("items", list())
287
+ if len(entries) == 0:
288
+ lines.append("(This namespace does not contain any documented type.)")
289
+ else:
290
+ for entry in entries:
291
+ lines.append(f"- [{TFCPS_CodeUnitSpecific_Base.__get_toc_entry_name(entry)}]({TFCPS_CodeUnitSpecific_Base.__get_toc_entry_link(entry)})")
292
+ return "\n".join(lines)+"\n"
293
+
294
+ @staticmethod
295
+ @GeneralUtilities.check_arguments
296
+ def __get_toc_entry_name(entry:dict)->str:
297
+ name:str = entry.get("name", entry.get("uid", GeneralUtilities.empty_string))
298
+ return name.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")# generic types like "List<T>" would be treated as html-tag otherwise
299
+
300
+ @staticmethod
301
+ @GeneralUtilities.check_arguments
302
+ def __get_toc_entry_link(entry:dict)->str:
303
+ uid:str = entry["uid"]
304
+ return "./"+uid.replace("`", "-")+".yml"# docfx replaces the backtick of generic types by a hyphen when generating the filenames
305
+
260
306
  @GeneralUtilities.check_arguments
261
307
  def use_cache(self)->bool:
262
308
  return self.__use_cache
@@ -107,8 +107,8 @@ class TFCPS_CodeUnit_BuildCodeUnits:
107
107
  self.sc.log.log(GeneralUtilities.get_line())
108
108
 
109
109
  self.search_for_secrets()
110
- self.__search_for_vulnerabilities()
111
110
  self.__normalize_md_and_txt_line_endings()
111
+ self.tfcps_tools_general.generate_svg_files_from_plantuml_files_for_repository(self.repository, self.use_cache())
112
112
 
113
113
  if self.is_pre_merge():
114
114
  self.__translate()
@@ -372,10 +372,6 @@ class TFCPS_CodeUnit_BuildCodeUnits:
372
372
  self.sc.generate_chart_diagram(diagram_definition_file,os.path.basename(diagram_svg_file))
373
373
  self.sc.format_xml_file(diagram_svg_file)
374
374
 
375
- @GeneralUtilities.check_arguments
376
- def __search_for_vulnerabilities(self):
377
- pass#TODO
378
-
379
375
  @GeneralUtilities.check_arguments
380
376
  def search_for_secrets(self) -> None:
381
377
  self.sc.log.log("Search for secrets...")
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: scriptcollection
3
- Version: 4.3.24
3
+ Version: 4.3.26
4
4
  Summary: The ScriptCollection is the place for reusable scripts.
5
5
  Author-email: Marius Göcke <marius.goecke@gmail.com>
6
6
  Project-URL: Homepage, https://github.com/anionDev/ScriptCollection
@@ -9,7 +9,7 @@ ScriptCollection/ProgramRunnerMock.py,sha256=uTu-aFle1W_oKjeQEmuPsFPQpvo0kRf2FrR
9
9
  ScriptCollection/ProgramRunnerPopen.py,sha256=zVD-gZY85o8wiGFcpYAGNDl-tXaKzipl1Bkhqy2ois4,4681
10
10
  ScriptCollection/ProgramRunnerSudo.py,sha256=RXsiceQ8W6a8YDk_2BPscVbIAmDIpIxqe9WHBy2r4CM,5233
11
11
  ScriptCollection/SCLog.py,sha256=LdzSJy3NnnwYCCefz2h4tiTy4BjT8lOz3IBG_bMOg9E,4821
12
- ScriptCollection/ScriptCollectionCore.py,sha256=tEKLwuMotHlhkBiBG8rWE2p99W5in34o0L1BPh5A7J4,240316
12
+ ScriptCollection/ScriptCollectionCore.py,sha256=Ljh_PPC5AmiWrFolh5LwiqYhkMJGYS8noIMaIaOuAbY,246308
13
13
  ScriptCollection/UnassignedVariablesCheck.py,sha256=v59qLQ5RRvx31ouuCW7NWZj3McWENvGBPkV5ZGBmqJE,4344
14
14
  ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
15
15
  ScriptCollection/OCIImages/AbstractImageHandler.py,sha256=WO2M28c2tUwsXFNa2L9zqMhdlyObWm3qpPE0LdIs7SE,2315
@@ -33,9 +33,9 @@ ScriptCollection/Resources/Fonts/DejaVuSans.ttf,sha256=faGVp0xVvvmI0NSPlQi9XYSUJ
33
33
  ScriptCollection/Resources/Fonts/LICENSE.txt,sha256=egg7E25k0GR5TDQZdR5cfdENL2TBCP5boWHq5eWVipM,8816
34
34
  ScriptCollection/Resources/MaintenanceSite/MaintenanceSite.html,sha256=CX9S1bdOz6xU2aGfr03tJRGczQrlpn-IeODc15d5kc0,232
35
35
  ScriptCollection/TFCPS/SCTaskRunnerServer.py,sha256=rpuwSsQ6YQfZS2LGnvOH5ql8zs_-cHU4LQttS7XNT60,11272
36
- ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py,sha256=oICRtl85n2puWvchcJIkmLZL1BAylMbzH7ltBGWfqgY,31973
36
+ ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py,sha256=H9FWlS6BPK-UWJXdWN686ePky4Hq-Q13T0Kx8HSJu7s,34990
37
37
  ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py,sha256=Ll5EOkpVpPiFrM2mLeQXolaF7075IwgtnHXvfdpkH4k,9904
38
- ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py,sha256=FAb1AIfsFUg4kIrSleDu1mjbGJTHmqVjTxSQBErtFcI,31104
38
+ ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py,sha256=uY1A8UeZZFFQ-Fdtf_V1zIWkvXCsePEpMtzZjamLmK4,31077
39
39
  ScriptCollection/TFCPS/TFCPS_CreateRelease.py,sha256=X2NgZgbOkJsdZ6wMHB_RuS_rQCuz5oQCqzYrxyXBN9Q,6680
40
40
  ScriptCollection/TFCPS/TFCPS_Generic.py,sha256=5vCFfDiU8bvfcnoKNs2ATS8nsl6mYXcIuX7XfYE0tvg,2116
41
41
  ScriptCollection/TFCPS/TFCPS_MergeToMain.py,sha256=zp7n0Li7GTi4tERDMgDcJ-o3m6131m31zvkat0lALEc,7781
@@ -49,7 +49,7 @@ ScriptCollection/TFCPS/Docker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
49
49
  ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationBase.py,sha256=bT6Gd5pQpZCw4OQz6HWkPCSn5z__eUUEisABLDSxd0o,200
50
50
  ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationGenerate.py,sha256=QyjOfMY22JWCvKjMelHiDWbJiWqotOfebpJpgDUaoO4,237
51
51
  ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationNoGenerate.py,sha256=i0zEGehj0sttxjjZtoq2KFSKp_ulxVyWp_ZgAhIY_So,241
52
- ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py,sha256=UInAjTB5W9nXBccHBaPGTkjWBy8saMfQ7bfiYlgBtYc,43893
52
+ ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py,sha256=ncSqBaJzmk8ZdVi3hnYJGNNQqPPomufwBfGUEPyifs8,43954
53
53
  ScriptCollection/TFCPS/DotNet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
54
54
  ScriptCollection/TFCPS/Flutter/TFCPS_CodeUnitSpecific_Flutter.py,sha256=d8U-sIhsneMplYkG73BJRQQZh4uLoX7QiOhbnZNuOM8,8540
55
55
  ScriptCollection/TFCPS/Flutter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -63,8 +63,8 @@ ScriptCollection/TFCPS/Python/TFCPS_CodeUnitSpecific_Python.py,sha256=Bd1gxCk9Fb
63
63
  ScriptCollection/TFCPS/Python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
64
64
  ScriptCollection/TFCPS/Rust/TFCPS_CodeUnitSpecific_Rust.py,sha256=WhOsMpJxNGqnQGA3nJ99ruyqymxBeJxCcpK98zJduTo,1680
65
65
  ScriptCollection/TFCPS/Rust/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
66
- scriptcollection-4.3.24.dist-info/METADATA,sha256=AUpaXJEauscIBMb5DUGDuQvcMu3e5M7mdzkFwackAdQ,7816
67
- scriptcollection-4.3.24.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
68
- scriptcollection-4.3.24.dist-info/entry_points.txt,sha256=Iq9YMSTWNCAJpBzM5L9CQx80tL9-XUu6MzDRAdBrIPg,5875
69
- scriptcollection-4.3.24.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
70
- scriptcollection-4.3.24.dist-info/RECORD,,
66
+ scriptcollection-4.3.26.dist-info/METADATA,sha256=aBbUEp_5x-4nl9nXzLQy9V4bHIIDkQrDCwZi2-1vBuw,7816
67
+ scriptcollection-4.3.26.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
68
+ scriptcollection-4.3.26.dist-info/entry_points.txt,sha256=Iq9YMSTWNCAJpBzM5L9CQx80tL9-XUu6MzDRAdBrIPg,5875
69
+ scriptcollection-4.3.26.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
70
+ scriptcollection-4.3.26.dist-info/RECORD,,