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

scoping details...
  • 18 extensions are included in analyses: py, md, json, txt, yaml, yml, sh, js, svg, html, css, ini, gitignore, gitattributes, toml, cjs, ps1, ipynb
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (400 files).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (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.
main113446 LOC (29%) 352 files
test239242 LOC (61%) 454 files
generated0 LOC (0%) 0 files
build and deployment1807 LOC (<1%) 19 files
other35914 LOC (9%) 414 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst

py112819 LOC (99%) 336 files
yaml455 LOC (<1%) 15 files
ps1172 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 352 files match defined criteria (113,446 LOC, 100.0% vs. main code):
    • 336 py files (112,819 LOC)
    • 15 yaml files (455 LOC)
    • 1 ps1 files (172 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py239242 LOC (100%) 454 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/test_.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*_tests[.].*".
    • files with paths like ".*/testing[.].*".
    • files with paths like ".*_test[.].*".
  • 454 files match defined criteria (239,242 LOC, 210.9% vs. main code). All matches are in py files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
gitattributes
Explore:   circles  |  sunburst

yaml1034 LOC (57%) 10 files
sh341 LOC (18%) 5 files
toml254 LOC (14%) 1 file
gitignore132 LOC (7%) 1 file
py44 LOC (2%) 1 file
gitattributes2 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
    • files with paths like ".*/setup[.]py".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
  • 19 files match defined criteria (1,807 LOC, 1.6% vs. main code):
    • 10 yaml files (1,034 LOC)
    • 5 sh files (341 LOC)
    • 1 toml files (254 LOC)
    • 1 gitignore files (132 LOC)
    • 1 py files (44 LOC)
    • 1 gitattributes files (2 LOC)
Other Code
ini
Explore:   circles  |  sunburst

py22863 LOC (63%) 222 files
md6481 LOC (18%) 111 files
json4875 LOC (13%) 60 files
js901 LOC (2%) 4 files
txt362 LOC (1%) 12 files
html300 LOC (<1%) 2 files
cjs63 LOC (<1%) 1 file
ipynb45 LOC (<1%) 1 file
ini24 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]ini".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[Ee]xamples/.*".
  • 414 files match defined criteria (35,914 LOC, 31.7% vs. main code):
    • 222 py files (22,863 LOC)
    • 111 md files (6,481 LOC)
    • 60 json files (4,875 LOC)
    • 4 js files (901 LOC)
    • 12 txt files (362 LOC)
    • 2 html files (300 LOC)
    • 1 cjs files (63 LOC)
    • 1 ipynb files (45 LOC)
    • 1 ini files (24 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
  • *.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
  • *.ps1 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