Source Code Analysis Scope
Files includes and excluded from analyses
in
gitattributes

scoping details...
  • 12 extensions are included in analyses: py, txt, md, yml, json, ipynb, in, svg, gitignore, gitattributes, toml, yaml
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (1 file).
    • exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
    • exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
    • exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (0 files).
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.
main3952 LOC (26%) 18 files
test310 LOC (2%) 7 files
generated0 LOC (0%) 0 files
build and deployment95 LOC (<1%) 4 files
other10508 LOC (70%) 7 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
in
Explore:   circles  |  sunburst

py2950 LOC (74%) 14 files
ipynb959 LOC (24%) 1 file
yaml38 LOC (<1%) 2 files
in5 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 18 files match defined criteria (3,952 LOC, 100.0% vs. main code):
    • 14 py files (2,950 LOC)
    • 1 ipynb files (959 LOC)
    • 2 yaml files (38 LOC)
    • 1 in files (5 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py232 LOC (74%) 6 files
yaml78 LOC (25%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*/test[.].*".
  • 7 files match defined criteria (310 LOC, 7.8% vs. main code):
    • 6 py files (232 LOC)
    • 1 yaml files (78 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
gitattributes
Explore:   circles  |  sunburst

toml47 LOC (49%) 1 file
yaml36 LOC (37%) 1 file
gitignore9 LOC (9%) 1 file
gitattributes3 LOC (3%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/[.]gitattributes".
  • 4 files match defined criteria (95 LOC, 2.4% vs. main code):
    • 1 toml files (47 LOC)
    • 1 yaml files (36 LOC)
    • 1 gitignore files (9 LOC)
    • 1 gitattributes files (3 LOC)
Other Code
Explore:   circles  |  sunburst

svg8461 LOC (80%) 1 file
json1741 LOC (16%) 1 file
md299 LOC (2%) 4 files
txt7 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]svg".
    • files with paths like ".*[.]json".
  • 7 files match defined criteria (10,508 LOC, 265.9% vs. main code):
    • 1 svg files (8,461 LOC)
    • 1 json files (1,741 LOC)
    • 4 md files (299 LOC)
    • 1 txt files (7 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, other)...

  • The main category contains all manually created source code files that are being used in the production.
  • Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
  • Test source code files are used only for testing of the product. These files are normally not deployed to production.
  • Build and deployment source code files are used to configure or support build and deployment process.
  • Generated source code files are automatically generated files that have not been manually changed after generation.
  • While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
  • Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

learn more about used code analyzers...
  • *.py files are analyzed with PythonAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.ipynb files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.yaml files are analyzed with YamlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.in files are analyzed with RustAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • No dependency analysis