jedi API reference

54 public APIs from jedi (davidhalter/jedi) — 25 classes, 13 functions, 16 methods. Signatures extracted by static analysis of the actual source.

Repository: davidhalter/jedi

Kind	Count
Classes	25
Functions	13
Methods	16

API list

classjedi.api.Interpreter

Jedi's API for Python REPLs.

methodjedi.api.Script.complete(line=None, column=None, *fuzzy=False)

Completes objects under the cursor.

methodjedi.api.Script.help(line=None, column=None)

Used to display a help window to users.

methodjedi.api.Script.inline(line=None, column=None)

Inlines a variable under the cursor.

methodjedi.api.Script.search(string, *all_scopes=False)

Searches a name in the current file.

classjedi.api.classes.BaseName

The base class for all definitions, completions and signatures.

methodjedi.api.classes.BaseName.full_name()

Dot-separated path of this object.

methodjedi.api.classes.BaseName.module_path() -> Optional[Path]

Shows the file path of a module.

methodjedi.api.classes.BaseName.name()

Name of variable/function/class/module.

methodjedi.api.classes.BaseName.type()

The type of the definition.

classjedi.api.classes.Completion

``Completion`` objects are returned from :meth:`.Script.complete`.

methodjedi.api.classes.Completion.complete()

Only works with non-fuzzy completions.

methodjedi.api.classes.Completion.type()

Documented under :meth:`BaseName.type`.

methodjedi.api.environment.Environment.get_sys_path()

The sys path for this environment.

classjedi.api.exceptions.InternalError

This error might happen a subprocess is crashing.

classjedi.api.exceptions.RefactoringError

Refactorings can fail for various reasons.

methodjedi.api.project.Project.load(path)

Loads a project from a specific path.

methodjedi.api.project.Project.path()

The base path for this project.

methodjedi.api.project.Project.sys_path()

The sys path provided to this project.

funcjedi.cache.memoize_method(method)

A normal memoize function.

funcjedi.debug.increase_indent(func)

Decorator for makin

classjedi.file_io.ZipFileIO

For .zip and .egg archives

funcjedi.inference.arguments.try_iter_content(types, depth=0)

Helper method for static analysis.

classjedi.inference.base_value.Value

To be implemented by subclasses.

funcjedi.inference.cache.inference_state_method_generator_cache()

This is a special memoizer.

classjedi.inference.compiled.mixed.MixedName

The ``CompiledName._compiled_value`` is our MixedObject.

classjedi.inference.compiled.mixed.MixedObject

A ``MixedObject`` is used in two ways: 1.

classjedi.inference.compiled.subprocess.InferenceStateSameProcess

Basically just an easy access to functions.py.

classjedi.inference.compiled.subprocess.InferenceStateSubprocess

API to functionality which will run in a subprocess.

classjedi.inference.compiled.value.EmptyCompiledName

Accessing some names will raise an exception.

classjedi.inference.context.ValueContext

Should be defined, otherwise the API returns empty types.

funcjedi.inference.gradual.annotation.infer_annotation(context, annotation)

Inferes an annotation node.

classjedi.inference.gradual.typing.TypedDict

Represents the instance version of ``TypedDictClass``.

classjedi.inference.lazy_value.LazyKnownValue

data is a Value.

classjedi.inference.lazy_value.LazyKnownValues

data is a ValueSet.

classjedi.inference.lazy_value.MergedLazyValues

data is a list of lazy values.

classjedi.inference.names.AbstractArbitraryName

When you e.g.

classjedi.inference.recursion.ExecutionRecursionDetector

Catches recursions of executions.

funcjedi.inference.syntax_tree.check_tuple_assignments(name, value_set)

Checks if tuples are assigned.

funcjedi.inference.syntax_tree.infer_atom(context, atom)

Basically to process ``atom`` nodes.

funcjedi.inference.utils.reraise_uncaught(func)

Re-throw uncaught `AttributeError`.

classjedi.inference.value.instance.SelfName

This name calculates the parent_context lazily.

classjedi.inference.value.iterable.Generator

Handling of `yield` functions.

classjedi.inference.value.klass.DataclassDecorator

A dataclass(-like) decorator with custom parameters.

methodjedi.inference.value.klass.DataclassTransformer.init_mode_from_new() -> bool

Default value if missing is ``True``

classjedi.inference.value.klass.DataclassWrapper

A class with dataclass semantics from a decorator.

funcjedi.inference.value.klass.get_dataclass_param_names(cls) -> List[DataclassParamName]

``cls`` is a :class:`ClassMixin`.

classjedi.inference.value.namespace.ImplicitNamespaceValue

Provides support for implicit namespace packages

methodjedi.inference.value.namespace.ImplicitNamespaceValue.py__package__()

Return the fullname

funcjedi.parser_utils.get_executable_nodes(node, last_added=False)

For static analysis.

funcjedi.parser_utils.get_parent_scope(node, include_flows=False)

Returns the underlying scope.

funcjedi.parser_utils.get_parso_cache_node(grammar, path)

This is of course not public.

funcjedi.parser_utils.move(node, line_offset)

Move the `Node` start_pos.

classjedi.plugins.stdlib.SuperInstance

To be used like the object ``super`` returns.

About this data

These signatures were extracted from the public source of davidhalter/jedi using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries