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

scoping details...
  • 17 extensions are included in analyses: py, json, js, html, txt, rst, toml, css, md, bat, iss, gitattributes, sh, yml, ini, svg, gitignore
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (34 files).
    • exclude files with path like ".*/docs?/_?(build|themes?|templates?|static)/.*" (Sphinx) (0 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.
main13339 LOC (19%) 82 files
test2671 LOC (3%) 44 files
generated0 LOC (0%) 0 files
build and deployment607 LOC (<1%) 10 files
other50737 LOC (75%) 103 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
iss
Explore:   circles  |  sunburst

py13302 LOC (99%) 81 files
iss37 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 82 files match defined criteria (13,339 LOC, 100.0% vs. main code):
    • 81 py files (13,302 LOC)
    • 1 iss files (37 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py2671 LOC (100%) 44 files

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 ".*/tests_.*".
  • 44 files match defined criteria (2,671 LOC, 20.0% 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

yaml393 LOC (64%) 1 file
toml137 LOC (22%) 5 files
bat45 LOC (7%) 1 file
gitignore15 LOC (2%) 1 file
sh14 LOC (2%) 1 file
gitattributes3 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]sh".
    • 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".
  • 10 files match defined criteria (607 LOC, 4.6% vs. main code):
    • 1 yaml files (393 LOC)
    • 5 toml files (137 LOC)
    • 1 bat files (45 LOC)
    • 1 gitignore files (15 LOC)
    • 1 sh files (14 LOC)
    • 1 gitattributes files (3 LOC)
Other Code
ini
Explore:   circles  |  sunburst

json50521 LOC (99%) 99 files
md208 LOC (<1%) 3 files
ini8 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*[.]ini".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]svg".
  • 103 files match defined criteria (50,737 LOC, 380.4% vs. main code):
    • 99 json files (50,521 LOC)
    • 3 md files (208 LOC)
    • 1 ini files (8 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
  • *.iss 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