Skip to content

jinja2 3.1.6

Download JSON

  • PyPI https://pypi.org/project/jinja2/
    Repository https://github.com/pallets/jinja

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 1807
    "Any" : 266
    "Untyped" : 210
    • 90.8% coverage
    • 79.2% coverage (strict)
    • 2283 typable
      • 1807 typed
      • 210 untyped
      • 266 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 490
    "classes" : 1435
    "other" : 68
    • 146 functions (+3 overloads)
      • 344 parameters
    • 147 classes
      • 544 methods (+2 overloads)
        • 867 parameters
      • 24 properties
    • 24 modules
      • 68 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
jinja2 0.0% 0.0% 0 0
jinja2.async_utils 75.0% 75.0% 8 1
jinja2.bccache 81.4% 81.4% 59 0
jinja2.compiler 89.7% 88.8% 340 0
jinja2.constants 0.0% 0.0% 0 0
jinja2.debug 100.0% 100.0% 9 0
jinja2.defaults 100.0% 100.0% 4 0
jinja2.environment 91.3% 83.3% 300 2
jinja2.exceptions 69.2% 69.2% 26 1
jinja2.ext 98.7% 98.7% 78 1
jinja2.filters 100.0% 90.4% 281 12
jinja2.idtracking 97.7% 74.4% 133 0
jinja2.lexer 46.7% 46.7% 135 3
jinja2.loaders 84.3% 84.3% 83 0
jinja2.meta 100.0% 100.0% 11 0
jinja2.nativetypes 96.0% 60.0% 25 1
jinja2.nodes 96.4% 88.3% 197 3
jinja2.optimizer 90.0% 70.0% 10 0
jinja2.parser 94.9% 94.9% 99 0
jinja2.runtime 92.8% 62.2% 249 6
jinja2.sandbox 96.8% 60.3% 63 1
jinja2.tests 100.0% 66.7% 51 0
jinja2.utils 95.2% 68.3% 104 0
jinja2.visitor 100.0% 44.4% 18 0

Incomplete Annotations

jinja2.async_utils (2 missing, 0 any)

Symbol Typable Typed Any
func async_variant 2 0 0

jinja2.bccache (11 missing, 0 any)

Symbol Typable Typed Any
meth MemcachedBytecodeCache.init 5 4 0
attr MemcachedBytecodeCache.client 1 0 0
attr MemcachedBytecodeCache.prefix 1 0 0
attr MemcachedBytecodeCache.timeout 1 0 0
attr MemcachedBytecodeCache.ignore_memcache_errors 1 0 0
attr FileSystemBytecodeCache.directory 1 0 0
attr FileSystemBytecodeCache.pattern 1 0 0
attr bc_magic 1 0 0
attr Bucket.environment 1 0 0
attr Bucket.key 1 0 0
attr Bucket.checksum 1 0 0

jinja2.compiler (35 missing, 3 any)

Symbol Typable Typed Any
attr UndeclaredNameVisitor.names 1 0 0
meth CodeGenerator._default_finalize 2 2 2
attr CodeGenerator.environment 1 0 0
attr CodeGenerator.name 1 0 0
attr CodeGenerator.filename 1 0 0
attr CodeGenerator.stream 1 0 0
attr CodeGenerator.created_block_context 1 0 0
attr CodeGenerator.defer_init 1 0 0
attr CodeGenerator.extends_so_far 1 0 0
attr CodeGenerator.has_known_extends 1 0 0
attr CodeGenerator.code_lineno 1 0 0
attr CodeGenerator.visit_Add 1 0 0
attr CodeGenerator.visit_Sub 1 0 0
attr CodeGenerator.visit_Mul 1 0 0
attr CodeGenerator.visit_Div 1 0 0
attr CodeGenerator.visit_FloorDiv 1 0 0
attr CodeGenerator.visit_Pow 1 0 0
attr CodeGenerator.visit_Mod 1 0 0
attr CodeGenerator.visit_And 1 0 0
attr CodeGenerator.visit_Or 1 0 0
attr CodeGenerator.visit_Pos 1 0 0
attr CodeGenerator.visit_Neg 1 0 0
attr CodeGenerator.visit_Not 1 0 0
attr MacroRef.node 1 0 0
attr MacroRef.accesses_caller 1 0 0
attr MacroRef.accesses_kwargs 1 0 0
attr MacroRef.accesses_varargs 1 0 0
func has_safe_repr 2 2 1
attr Frame.eval_ctx 1 0 0
attr Frame.parent 1 0 0
attr Frame.toplevel 1 0 0
attr Frame.rootlevel 1 0 0
attr Frame.loop_frame 1 0 0
attr Frame.block_frame 1 0 0
attr Frame.soft_frame 1 0 0
attr Frame.symbols 1 0 0
attr Frame.require_output_check 1 0 0

jinja2.environment (26 missing, 24 any)

Symbol Typable Typed Any
meth Environment.init 23 22 0
meth Environment.extend 2 2 1
meth Environment.getitem 3 3 1
meth Environment.getattr 3 3 2
meth Environment._filter_test_common 8 8 2
meth Environment.call_filter 7 7 2
meth Environment.call_test 7 7 2
attr Environment.block_start_string 1 0 0
attr Environment.block_end_string 1 0 0
attr Environment.variable_start_string 1 0 0
attr Environment.variable_end_string 1 0 0
attr Environment.comment_start_string 1 0 0
attr Environment.comment_end_string 1 0 0
attr Environment.line_statement_prefix 1 0 0
attr Environment.line_comment_prefix 1 0 0
attr Environment.trim_blocks 1 0 0
attr Environment.lstrip_blocks 1 0 0
attr Environment.newline_sequence 1 0 0
attr Environment.keep_trailing_newline 1 0 0
attr Environment.optimized 1 0 0
attr Environment.finalize 1 0 0
attr Environment.autoescape 1 0 0
attr Environment.filters 1 0 0
attr Environment.tests 1 0 0
attr Environment.globals 1 0 0
attr Environment.loader 1 0 0
attr Environment.cache 1 0 0
attr Environment.bytecode_cache 1 0 0
attr Environment.auto_reload 1 0 0
attr Environment.policies 1 0 0
attr Environment.extensions 1 0 0
attr Environment.is_async 1 0 0
meth Template.new 20 20 1
meth Template.render 3 3 2
meth Template.render_async 3 3 2
meth Template.stream 3 3 2
meth Template.generate 3 3 2
meth Template.generate_async 3 3 2
meth TemplateExpression.call 3 3 2
func get_spontaneous_environment 3 3 1

jinja2.exceptions (8 missing, 0 any)

Symbol Typable Typed Any
meth TemplateSyntaxError.reduce 1 0 0
attr TemplateSyntaxError.lineno 1 0 0
attr TemplateSyntaxError.name 1 0 0
attr TemplateSyntaxError.filename 1 0 0
attr TemplateSyntaxError.translated 1 0 0
attr TemplateNotFound.name 1 0 0
attr TemplateNotFound.templates 1 0 0
attr TemplatesNotFound.templates 1 0 0

jinja2.ext (1 missing, 0 any)

Symbol Typable Typed Any
attr Extension.environment 1 0 0

jinja2.filters (0 missing, 27 any)

Symbol Typable Typed Any
func do_int 4 4 1
func do_tojson 4 4 1
func sync_do_select 5 5 2
func do_attr 4 4 1
func sync_do_rejectattr 5 5 2
func sync_do_map 8 8 2
func do_reject 5 5 2
func do_pprint 2 2 1
func do_map 8 8 2
func do_selectattr 5 5 2
func do_select 5 5 2
func do_rejectattr 5 5 2
func sync_do_selectattr 5 5 2
func sync_do_reject 5 5 2
func do_format 4 4 2
func do_float 3 3 1

jinja2.idtracking (3 missing, 31 any)

Symbol Typable Typed Any
meth RootVisitor._simple_visit 3 3 1
meth RootVisitor.visit_Template 3 3 1
meth RootVisitor.visit_Block 3 3 1
meth RootVisitor.visit_Macro 3 3 1
meth RootVisitor.visit_FilterBlock 3 3 1
meth RootVisitor.visit_Scope 3 3 1
meth RootVisitor.visit_If 3 3 1
meth RootVisitor.visit_ScopedEvalContextModifier 3 3 1
meth RootVisitor.visit_AssignBlock 3 3 1
meth RootVisitor.visit_CallBlock 3 3 1
meth RootVisitor.visit_OverlayScope 3 3 1
meth RootVisitor.visit_For 4 4 1
meth RootVisitor.visit_With 3 3 1
meth RootVisitor.generic_visit 4 4 2
attr RootVisitor.sym_visitor 1 0 0
meth Symbols.analyze_node 3 3 1
attr Symbols.parent 1 0 0
meth FrameSymbolVisitor.visit_Name 4 4 1
meth FrameSymbolVisitor.visit_NSRef 3 3 1
meth FrameSymbolVisitor.visit_If 3 3 1
meth FrameSymbolVisitor.visit_Macro 3 3 1
meth FrameSymbolVisitor.visit_Import 3 3 1
meth FrameSymbolVisitor.visit_FromImport 3 3 1
meth FrameSymbolVisitor.visit_Assign 3 3 1
meth FrameSymbolVisitor.visit_For 3 3 1
meth FrameSymbolVisitor.visit_CallBlock 3 3 1
meth FrameSymbolVisitor.visit_FilterBlock 3 3 1
meth FrameSymbolVisitor.visit_With 3 3 1
meth FrameSymbolVisitor.visit_AssignBlock 3 3 1
meth FrameSymbolVisitor.visit_Scope 3 3 1
meth FrameSymbolVisitor.visit_Block 3 3 1
meth FrameSymbolVisitor.visit_OverlayScope 3 3 1
attr FrameSymbolVisitor.symbols 1 0 0

jinja2.lexer (72 missing, 0 any)

Symbol Typable Typed Any
attr TOKEN_LINECOMMENT 1 0 0
attr TOKEN_COMMENT_BEGIN 1 0 0
attr TOKEN_EOF 1 0 0
attr float_re 1 0 0
attr TOKEN_LINECOMMENT_BEGIN 1 0 0
attr TOKEN_STRING 1 0 0
attr TOKEN_COMMENT 1 0 0
attr TOKEN_POW 1 0 0
attr TOKEN_RBRACE 1 0 0
attr TOKEN_VARIABLE_END 1 0 0
attr TOKEN_GT 1 0 0
attr ignore_if_empty 1 0 0
attr Failure.message 1 0 0
attr Failure.error_class 1 0 0
attr string_re 1 0 0
attr ignored_tokens 1 0 0
attr TOKEN_LPAREN 1 0 0
attr TOKEN_MUL 1 0 0
attr TOKEN_LINECOMMENT_END 1 0 0
attr TOKEN_BLOCK_BEGIN 1 0 0
attr TOKEN_TILDE 1 0 0
attr TOKEN_RAW_END 1 0 0
attr TOKEN_RPAREN 1 0 0
attr TOKEN_NAME 1 0 0
attr TOKEN_OPERATOR 1 0 0
attr TOKEN_COLON 1 0 0
attr TOKEN_LT 1 0 0
attr TOKEN_DIV 1 0 0
attr TOKEN_EQ 1 0 0
attr TokenStreamIterator.stream 1 0 0
attr TOKEN_GTEQ 1 0 0
attr TOKEN_SUB 1 0 0
attr TOKEN_LBRACE 1 0 0
attr TOKEN_INITIAL 1 0 0
attr TOKEN_LINESTATEMENT_BEGIN 1 0 0
attr reverse_operators 1 0 0
attr TOKEN_BLOCK_END 1 0 0
attr TOKEN_DATA 1 0 0
attr TOKEN_WHITESPACE 1 0 0
attr TOKEN_LTEQ 1 0 0
attr TOKEN_ASSIGN 1 0 0
attr TOKEN_SEMICOLON 1 0 0
attr TOKEN_PIPE 1 0 0
attr TOKEN_LBRACKET 1 0 0
attr operator_re 1 0 0
meth OptionalLStrip.new 3 0 0
attr TOKEN_COMMENT_END 1 0 0
attr TOKEN_FLOORDIV 1 0 0
meth TokenStream.init 4 3 0
attr TokenStream.name 1 0 0
attr TokenStream.filename 1 0 0
attr TokenStream.closed 1 0 0
attr TokenStream.current 1 0 0
attr newline_re 1 0 0
attr TOKEN_ADD 1 0 0
attr integer_re 1 0 0
attr TOKEN_RBRACKET 1 0 0
attr TOKEN_FLOAT 1 0 0
attr TOKEN_VARIABLE_BEGIN 1 0 0
attr TOKEN_RAW_BEGIN 1 0 0
attr TOKEN_LINESTATEMENT_END 1 0 0
attr TOKEN_DOT 1 0 0
attr TOKEN_NE 1 0 0
attr TOKEN_COMMA 1 0 0
attr whitespace_re 1 0 0
attr TOKEN_INTEGER 1 0 0
attr TOKEN_MOD 1 0 0
attr Lexer.lstrip_blocks 1 0 0
attr Lexer.newline_sequence 1 0 0
attr Lexer.keep_trailing_newline 1 0 0

jinja2.loaders (13 missing, 0 any)

Symbol Typable Typed Any
attr ChoiceLoader.loaders 1 0 0
attr FileSystemLoader.searchpath 1 0 0
attr FileSystemLoader.encoding 1 0 0
attr FileSystemLoader.followlinks 1 0 0
attr PackageLoader.package_path 1 0 0
attr PackageLoader.package_name 1 0 0
attr PackageLoader.encoding 1 0 0
attr ModuleLoader.module 1 0 0
attr ModuleLoader.package_name 1 0 0
attr DictLoader.mapping 1 0 0
attr PrefixLoader.mapping 1 0 0
attr PrefixLoader.delimiter 1 0 0
attr FunctionLoader.load_func 1 0 0

jinja2.nativetypes (1 missing, 9 any)

Symbol Typable Typed Any
attr NativeEnvironment.concat 1 0 0
meth NativeCodeGenerator._default_finalize 2 2 2
meth NativeCodeGenerator._output_child_to_const 4 4 1
meth NativeTemplate.render 3 3 3
meth NativeTemplate.render_async 3 3 3

jinja2.nodes (7 missing, 16 any)

Symbol Typable Typed Any
meth Or.as_const 2 2 1
meth And.as_const 2 2 1
meth UnaryExpr.as_const 2 2 1
meth NodeType.new 4 0 0
meth Node.init 3 3 2
meth Node.eq 2 2 1
attr EvalContext.environment 1 0 0
attr EvalContext.volatile 1 0 0
attr EvalContext.autoescape 1 0 0
meth Getitem.as_const 2 2 1
meth CondExpr.as_const 2 2 1
meth Const.as_const 2 2 1
meth Const.from_untrusted 4 4 1
attr Const.value 1 1 1
meth Expr.as_const 2 2 1
meth Compare.as_const 2 2 1
meth Filter.as_const 2 2 1
meth BinExpr.as_const 2 2 1
meth Getattr.as_const 2 2 1

jinja2.optimizer (1 missing, 2 any)

Symbol Typable Typed Any
meth Optimizer.generic_visit 4 4 2
attr Optimizer.environment 1 0 0

jinja2.parser (5 missing, 0 any)

Symbol Typable Typed Any
attr Parser.environment 1 0 0
attr Parser.stream 1 0 0
attr Parser.name 1 0 0
attr Parser.filename 1 0 0
attr Parser.closed 1 0 0

jinja2.runtime (18 missing, 76 any)

Symbol Typable Typed Any
meth Undefined.init 5 5 1
meth Undefined._fail_with_undefined_error 3 3 2
meth Undefined.getattr 2 2 1
meth Undefined.add 3 3 2
meth Undefined.radd 3 3 2
meth Undefined.sub 3 3 2
meth Undefined.rsub 3 3 2
meth Undefined.mul 3 3 2
meth Undefined.rmul 3 3 2
meth Undefined.div 3 3 2
meth Undefined.rdiv 3 3 2
meth Undefined.truediv 3 3 2
meth Undefined.rtruediv 3 3 2
meth Undefined.floordiv 3 3 2
meth Undefined.rfloordiv 3 3 2
meth Undefined.mod 3 3 2
meth Undefined.rmod 3 3 2
meth Undefined.pos 3 3 2
meth Undefined.neg 3 3 2
meth Undefined.call 3 3 2
meth Undefined.getitem 3 3 2
meth Undefined.lt 3 3 2
meth Undefined.le 3 3 2
meth Undefined.gt 3 3 2
meth Undefined.ge 3 3 2
meth Undefined.int 3 3 2
meth Undefined.float 3 3 2
meth Undefined.complex 3 3 2
meth Undefined.pow 3 3 2
meth Undefined.rpow 3 3 2
meth Undefined.eq 2 2 1
meth Undefined.ne 2 2 1
attr BlockReference.name 1 0 0
meth Macro.init 9 8 0
meth Macro.call 3 3 2
attr Macro.name 1 0 0
attr Macro.arguments 1 0 0
attr Macro.catch_kwargs 1 0 0
attr Macro.catch_varargs 1 0 0
attr Macro.caller 1 0 0
attr Macro.explicit_caller 1 0 0
meth TemplateReference.getitem 2 2 1
meth AsyncLoopContext._peek_next 1 1 1
meth LoopContext._peek_next 1 1 1
meth LoopContext.changed 2 2 1
attr LoopContext._after 1 1 1
attr LoopContext._current 1 1 1
attr LoopContext._before 1 1 1
attr LoopContext._last_changed_value 1 1 1
attr LoopContext.depth0 1 0 0
meth Context.init 6 5 0
meth Context.get 3 3 2
meth Context.resolve_or_missing 2 2 1
meth Context.call 4 4 2
meth Context.getitem 2 2 1
attr Context.parent 1 0 0
attr Context.eval_ctx 1 0 0
attr Context.name 1 0 0
attr Context.globals_keys 1 0 0
attr Context.blocks 1 0 0
attr Context.keys 1 0 0
attr Context.values 1 0 0
attr Context.items 1 0 0

jinja2.sandbox (2 missing, 23 any)

Symbol Typable Typed Any
meth ImmutableSandboxedEnvironment.is_safe_attribute 4 4 2
func is_internal_attribute 3 3 1
func modifies_known_mutable 3 3 1
meth SandboxedFormatter.init 3 3 1
meth SandboxedEnvironment.init 3 3 2
meth SandboxedEnvironment.is_safe_attribute 4 4 2
meth SandboxedEnvironment.is_safe_callable 2 2 1
meth SandboxedEnvironment.call_binop 5 5 3
meth SandboxedEnvironment.call_unop 4 4 2
meth SandboxedEnvironment.getitem 3 3 1
meth SandboxedEnvironment.getattr 3 3 1
meth SandboxedEnvironment.unsafe_undefined 3 3 1
meth SandboxedEnvironment.wrap_str_format 2 2 1
meth SandboxedEnvironment.call 5 5 4
attr SandboxedEnvironment.binop_table 1 0 0
attr SandboxedEnvironment.unop_table 1 0 0

jinja2.tests (0 missing, 17 any)

Symbol Typable Typed Any
func test_float 2 2 1
func test_escaped 2 2 1
func test_false 2 2 1
func test_defined 2 2 1
func test_undefined 2 2 1
func test_sequence 2 2 1
func test_mapping 2 2 1
func test_string 2 2 1
func test_none 2 2 1
func test_iterable 2 2 1
func test_integer 2 2 1
func test_number 2 2 1
func test_boolean 2 2 1
func test_in 3 3 1
func test_true 2 2 1
func test_sameas 3 3 2

jinja2.utils (5 missing, 28 any)

Symbol Typable Typed Any
func is_undefined 2 2 1
attr Joiner.sep 1 0 0
attr Joiner.used 1 0 0
attr missing 1 1 1
func url_quote 4 4 1
func pformat 2 2 1
meth Cycler.init 2 2 1
meth Cycler.next 1 1 1
meth Cycler.next 1 1 1
prop Cycler.current 1 1 1
attr Cycler.items 1 0 0
attr Cycler.pos 1 0 0
meth Namespace.init 3 3 2
meth Namespace.getattribute 2 2 1
meth Namespace.setitem 3 3 1
func import_string 3 3 1
func object_type_repr 2 2 1
meth LRUCache.get 3 3 3
meth LRUCache.setdefault 3 3 3
meth LRUCache.contains 2 2 1
meth LRUCache.getitem 2 2 2
meth LRUCache.setitem 3 3 2
meth LRUCache.delitem 2 2 1
attr LRUCache.capacity 1 0 0
func htmlsafe_json_dumps 4 4 2

jinja2.visitor (0 missing, 10 any)

Symbol Typable Typed Any
meth NodeTransformer.generic_visit 4 4 2
meth NodeTransformer.visit_list 4 4 2
meth NodeVisitor.visit 4 4 3
meth NodeVisitor.generic_visit 4 4 3

Type-Ignore Comments

Flavor Count
type: ignore 27
type: ignore[attr-defined] 2
type: ignore[override] 1
type: ignore[type-arg] 1