apache / pulsar-client-python
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
txt
clang-format
patch
gitmodules
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.

main2871 LOC (41%) 33 files
test3082 LOC (45%) 13 files
generated0 LOC (0%) 0 files
build and deployment296 LOC (4%) 7 files
other595 LOC (8%) 13 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
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 33 files match defined criteria (2,871 LOC, 100.0% vs. main code):
    • 16 *.py files (1,598 LOC)
    • 13 *.cc files (1,061 LOC)
    • 2 *.h files (116 LOC)
    • 1 *.cmake files (93 LOC)
    • 1 *.yaml files (3 LOC)
  • " *.py" is biggest, containing 55.66% of LOC.
  • " *.yaml" is smallest, containing 0.1% of LOC.


*.py1598 LOC (55%) 16 files
*.cc1061 LOC (36%) 13 files
*.h116 LOC (4%) 2 files
*.cmake93 LOC (3%) 1 file
*.yaml3 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*[-]test[-].*".
  • 13 files match defined criteria (3,082 LOC, 107.3% vs. main code):
    • 9 *.py files (2,982 LOC)
    • 4 *.sh files (100 LOC)
  • " *.py" is biggest, containing 96.76% of LOC.
  • " *.sh" is smallest, containing 3.24% of LOC.


*.py2982 LOC (96%) 9 files
*.sh100 LOC (3%) 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 ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]gitmodules".
  • 7 files match defined criteria (296 LOC, 10.3% vs. main code). All matches are in *.sh files.


*.sh296 LOC (100%) 7 files
Other Code
txt
patch
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]patch".
  • 13 files match defined criteria (595 LOC, 20.7% vs. main code):
    • 4 *.md files (331 LOC)
    • 2 *.txt files (115 LOC)
    • 4 *.py files (112 LOC)
    • 1 *.avsc files (21 LOC)
    • 1 *.patch files (12 LOC)
    • 1 *.json files (4 LOC)
  • " *.md" is biggest, containing 55.63% of LOC.
  • " *.json" is smallest, containing 0.67% of LOC.


*.md331 LOC (55%) 4 files
*.txt115 LOC (19%) 2 files
*.py112 LOC (18%) 4 files
*.avsc21 LOC (3%) 1 file
*.patch12 LOC (2%) 1 file
*.json4 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.


2025-05-07 20:41