VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-06 14:04:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add deprecations for Script parameters line/column/encoding

Browse Source
This commit is contained in:
Dave Halter
2020-03-16 09:41:47 +01:00
parent 25af28946e
commit 6d79ac9fde
1 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
jedi/api/__init__.py
View File

@@ -101,13 +101,15 @@ class Script(object):
:param path: The path of the file in the file system, or ``''`` if :param path: The path of the file in the file system, or ``''`` if
it hasn't been saved yet. it hasn't been saved yet.
:type path: str or None :type path: str or None
:param encoding: The encoding of ``source``, if it is not a :param encoding: Deprecated, cast to unicode yourself. The encoding of
``unicode`` object (default ``'utf-8'``). ``source``, if it is not a ``unicode`` object (default ``'utf-8'``).
:type encoding: str :type encoding: str
:param sys_path: Deprecated, use the project parameter. :param sys_path: Deprecated, use the project parameter.
:type sys_path: list of str :type sys_path: list of str
:param Environment environment: Provide a predefined environment to work :param Environment environment: Provide a predefined environment to work
with a specific Python version or virtualenv. with a specific Python version or virtualenv.
:param Project project: Provide a predefined environment to work
with a specific Python version or virtualenv.
""" """
def __init__(self, source=None, line=None, column=None, path=None, def __init__(self, source=None, line=None, column=None, path=None,
encoding='utf-8', sys_path=None, environment=None, encoding='utf-8', sys_path=None, environment=None,
@@ -138,6 +140,28 @@ class Script(object):
DeprecationWarning, DeprecationWarning,
stacklevel=2 stacklevel=2
) )
if encoding is not None:
warnings.warn(
"Deprecated since version 0.17.0. You should cast to valid "
"unicode yourself, especially if you are not using utf-8.",
DeprecationWarning,
stacklevel=2
)
if line is not None:
warnings.warn(
"Providing the line is now done in the functions themselves "
"like `Script(...).complete(line, column)`",
DeprecationWarning,
stacklevel=2
)
if column is not None:
warnings.warn(
"Providing the column is now done in the functions themselves "
"like `Script(...).complete(line, column)`",
DeprecationWarning,
stacklevel=2
)
self._inference_state = InferenceState( self._inference_state = InferenceState(
project, environment=environment, script_path=self.path project, environment=environment, script_path=self.path
) )