microsoft / pyright
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
pyi
txt
gitattributes
vscodeignore
eslintignore
prettierignore
  • 14 extensions are included in analyses: pyi, py, ts, toml, json, md, js, txt, gitignore, yml, gitattributes, vscodeignore, eslintignore, prettierignore
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (15 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (14 files).
    • exclude files with path like ".*/extern(al)?/.*" (Dependencies) (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) (0 files).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (3 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.

  • 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.

main181351 LOC (70%) 2485 files
test25228 LOC (9%) 337 files
generated15370 LOC (5%) 4 files
build and deployment193 LOC (<1%) 3 files
other34504 LOC (13%) 782 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
pyi
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 2485 files match defined criteria (181,351 lines of code, 100.0% vs. main code):
    • 2,224 *.pyi files (102,700 lines of code)
    • 139 *.ts files (78,297 lines of code)
    • 113 *.toml files (185 lines of code)
    • 9 *.js files (169 lines of code)
  • " *.pyi" is biggest, containing 56.63% of code.
  • " *.js" is smallest, containing 0.09% of code.


*.pyi102700 LOC (56%) 2224 files
*.ts78297 LOC (43%) 139 files
*.toml185 LOC (<1%) 113 files
*.js169 LOC (<1%) 9 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
pyi
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*/[Ss]pecs/.*".
    • files with any line of content like ".*/simpletest/.*".
    • files with paths like ".*(/|[-])selenium/.*".
  • 337 files match defined criteria (25,228 lines of code, 13.9% vs. main code):
    • 251 *.ts files (23,489 lines of code)
    • 85 *.pyi files (1,738 lines of code)
    • 1 *.toml files (1 lines of code)
  • " *.ts" is biggest, containing 93.11% of code.
  • " *.toml" is smallest, containing 0% of code.


*.ts23489 LOC (93%) 251 files
*.pyi1738 LOC (6%) 85 files
*.toml1 LOC (<1%) 1 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 4 files match defined criteria (15,370 lines of code, 8.5% vs. main code). All matches are in *.json files.


*.json15370 LOC (100%) 4 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*([.]|/)webpack([.]|/).*".
    • files with paths like ".*/package[-]lock[.]json".
    • files with paths like ".*/package[.]json".
  • 3 files match defined criteria (193 lines of code, 0.1% vs. main code). All matches are in *.js files.


*.js193 LOC (100%) 3 files
Other Code
pyi
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]eslintignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]prettierignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*/[.]vscodeignore".
  • 782 files match defined criteria (34,504 lines of code, 19.0% vs. main code):
    • 31 *.json files (17,708 lines of code)
    • 739 *.py files (16,088 lines of code)
    • 7 *.md files (673 lines of code)
    • 4 *.pyi files (30 lines of code)
    • 1 *.toml files (5 lines of code)
  • " *.json" is biggest, containing 51.32% of code.
  • " *.toml" is smallest, containing 0.01% of code.


*.json17708 LOC (51%) 31 files
*.py16088 LOC (46%) 739 files
*.md673 LOC (1%) 7 files
*.pyi30 LOC (<1%) 4 files
*.toml5 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.pyi 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
  • *.ts files are analyzed with TypeScriptAnalyzer:
    • 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
  • *.toml 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
  • *.js files are analyzed with JavaScriptAnalyzer:
    • 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


2022-01-31 01:01