class Analyzer::Python::Litestar

Defined in:

analyzer/analyzers/python/litestar.cr

Constant Summary

CLASS_HEAD_RE = /^\s*class\s+(#{PYTHON_VAR_NAME_REGEX})\s*\(/
CONTROLLER_CLASS_RE = /^\s*class\s+(#{PYTHON_VAR_NAME_REGEX})\s*\(([^)]*)\)/
DECORATOR_PATH_KW_REGEX = /path\s*=\s*[rf]?['"]([^'"]*)['"]/
DECORATOR_PATH_LIST_KW_RE = /path\s*=\s*\[([^\]]*)\]/
DECORATOR_PATH_LIST_REGEX = /^\s*\[([^\]]*)\]/
DECORATOR_PATH_REGEX = /^\s*[rf]?['"]([^'"]*)['"]/

Path literal inside a decorator. Litestar accepts both a positional path and an explicit path= keyword argument. List forms (@get(["/a", "/b"]), @get(path=["/a", "/b"])) and omitted paths (@get(), @get(sync_to_thread=False) → default "" / /) are handled by extract_decorator_paths.

DECORATOR_REGEX = /@(get|post|put|patch|delete|head|options|route|websocket(?:_listener|_stream)?)\s*\(([^)]*)/

Decorator matching: @get("/path"), @post("/path"), etc. The tail after the path literal is captured so extra kwargs (like methods=) can be inspected for multi-method @route decorators. websocket(?:_listener|_stream)? also matches Litestar's @websocket_listener("/ws") and @websocket_stream("/ws") decorators (the listener/stream class-based WS handlers), which take a positional path just like @websocket — without the variants every listener/stream endpoint was silently dropped.

DOTTED_HANDLER_RE = /(#{PYTHON_VAR_NAME_REGEX})\.(#{PYTHON_VAR_NAME_REGEX})/

Hoisted out of the per-line/per-param loops: an interpolated regex literal recompiles (PCRE2 JIT) on every evaluation, and these interpolate only constants or fixed sets. The .to_s expansion is byte-identical to the previous inline form, so matching behaviour is unchanged.

HTTP_METHOD_KW_REGEX = /http_method\s*=\s*(?:\[([^\]]*)\]|['"]([^'"]+)['"])/
PATH_PARAM_REGEX = /\{([a-zA-Z_][a-zA-Z0-9_]*)(?::[a-zA-Z_][a-zA-Z0-9_]*)?\}/

Path param: {name} or {name:type}. Litestar uses the :type suffix as a converter (int, str, uuid, path, float); strip it when exposing the param.

PRIMITIVE_TYPE_PATTERNS = ["str", "int", "float", "bool", "bytes", "UUID", "date", "datetime"].map do |t| /\b#{t}\b/ end

classify_param runs once per typed handler parameter and rebuilt one PCRE2 pattern per primitive type on every call.

REQUEST_ATTR_PATTERNS = (["query_params", "path_params", "headers", "cookies"] of ::String).to_h do |attr| {attr, {/request\.#{attr}\[\s*[rf]?['"]([^'"]+)['"]\s*\]/, /request\.#{attr}\.get\(\s*[rf]?['"]([^'"]+)['"]/}} end

collect_request_attr_params runs twice per handler-body line per attribute; the attribute set is fixed, so precompile the patterns.

ROUTER_REGEX = /(#{PYTHON_VAR_NAME_REGEX})\s*=\s*Router\s*\(([^)]*)\)/m

Router(path="/prefix", route_handlers=[...])

TYPED_PATH_PARAM_REGEX = /\{([a-zA-Z_][a-zA-Z0-9_]*):[a-zA-Z_][a-zA-Z0-9_]*\}/

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer::Python::PythonEngine

build_callees_from(body : String, body_start_line : Int32, path : String, *, definition_base_path : String | Nil = nil, source : String | Nil = nil) : Array(Callee) build_callees_from, find_def_line(lines : Array(String), decorator_line : Int32) : Int32 | Nil find_def_line, find_imported_modules(app_base_path : String, file_path : String, content : String | Nil = nil) : Hash(String, Tuple(String, Int32)) find_imported_modules, find_imported_package(package_path : String, dotted_as_names : String) : Array(Tuple(String, String, Int32)) find_imported_package, find_json_params(codeblock_lines : Array(String), json_var_names : Array(String)) : Array(Param) find_json_params, join_until_python_call_closes(lines : Array(String), index : Int32, line : String) : String join_until_python_call_closes, parse_code_block(data : String | Array(String), after : Regex | Nil = nil) : String | Nil parse_code_block, parse_function_def(source_lines : Array(String), start_index : Int32) : FunctionDefinition | Nil parse_function_def, push_callees_from(endpoint : Endpoint, body : String, body_start_line : Int32, path : String, *, definition_base_path : String | Nil = nil, source : String | Nil = nil) : Nil push_callees_from, python_bracket_delta(line : String) : Int32 python_bracket_delta, python_paren_delta(line : String) : Int32 python_paren_delta, python_signature_line_span(lines : Array(String)) : Int32 python_signature_line_span, return_literal_value(data : String) : String return_literal_value

Class methods inherited from class Analyzer::Python::PythonEngine

python_test_path?(path : String, base_path : String | Nil = nil) : Bool python_test_path?

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]