Skip to content

Deprecate utils.is_str #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/pygccxml/declarations/container_traits.py
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ def remove_defaults(self, type_or_string):
"""

name = type_or_string
if not utils.is_str(type_or_string):
if not isinstance(type_or_string, str):
name = self.class_declaration(type_or_string).name
if not self.remove_defaults_impl:
return name
Expand Down Expand Up @@ -705,7 +705,7 @@ def find_container_traits(cls_or_string):
declarations.container_traits: a container traits
"""

if utils.is_str(cls_or_string):
if isinstance(cls_or_string, str):
if not templates.is_instantiation(cls_or_string):
return None
name = templates.name(cls_or_string)
Expand Down
8 changes: 4 additions & 4 deletions src/pygccxml/declarations/type_traits.py
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ def is_std_string(type_):

"""

if utils.is_str(type_):
if isinstance(type_, str):
return type_ in string_equivalences

type_ = remove_alias(type_)
Expand All @@ -522,7 +522,7 @@ def is_std_wstring(type_):

"""

if utils.is_str(type_):
if isinstance(type_, str):
return type_ in wstring_equivalences

type_ = remove_alias(type_)
Expand All @@ -537,7 +537,7 @@ def is_std_ostream(type_):

"""

if utils.is_str(type_):
if isinstance(type_, str):
return type_ in ostream_equivalences

type_ = remove_alias(type_)
Expand All @@ -552,7 +552,7 @@ def is_std_wostream(type_):

"""

if utils.is_str(type_):
if isinstance(type_, str):
return type_ in wostream_equivalences

type_ = remove_alias(type_)
Expand Down
3 changes: 1 addition & 2 deletions src/pygccxml/parser/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
from ConfigParser import SafeConfigParser as ConfigParser
except ImportError:
from configparser import ConfigParser
from .. import utils


class parser_configuration_t(object):
Expand Down Expand Up @@ -383,7 +382,7 @@ def load_xml_generator_configuration(configuration, **defaults):

"""
parser = configuration
if utils.is_str(configuration):
if isinstance(configuration, str):
parser = ConfigParser()
parser.read(configuration)

Expand Down
3 changes: 1 addition & 2 deletions src/pygccxml/parser/linker.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# See http://www.boost.org/LICENSE_1_0.txt

from pygccxml import declarations
from .. import utils


class linker_t(
Expand Down Expand Up @@ -304,7 +303,7 @@ def visit_member_variable_type(self):
self.__link_compound_type()

def visit_declarated(self):
if utils.is_str(self.__inst.declaration):
if isinstance(self.__inst.declaration, str):
self.__inst.declaration = self.__decls[self.__inst.declaration]

def visit_restrict(self):
Expand Down
4 changes: 2 additions & 2 deletions src/pygccxml/parser/project_reader.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ def __init__(self, config, cache=None, decl_factory=None):
self.__dcache = None
if isinstance(cache, declarations_cache.cache_base_t):
self.__dcache = cache
elif utils.is_str(cache):
elif isinstance(cache, str):
self.__dcache = declarations_cache.file_cache_t(cache)
else:
self.__dcache = declarations_cache.dummy_cache_t()
Expand Down Expand Up @@ -221,7 +221,7 @@ def get_os_file_names(files):

fnames = []
for f in files:
if utils.is_str(f):
if isinstance(f, str):
fnames.append(f)
elif isinstance(f, file_configuration_t):
if f.content_type in (
Expand Down
2 changes: 1 addition & 1 deletion src/pygccxml/parser/scanner.py
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ def startElement(self, name, attrs):
self.__update_membership(attrs)
self.__read_attributes(obj, attrs)

elif utils.is_str(obj):
elif isinstance(obj, str):

self.__files[element_id] = os.path.normpath(obj)

Expand Down
5 changes: 5 additions & 0 deletions src/pygccxml/utils/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ def is_str(string):
bool: True or False

"""
warnings.warn(
"The is_str function is deprecated. \
Use isinstance(string, str) instead.",
DeprecationWarning)

if sys.version_info[:2] >= (3, 0):
return isinstance(string, str)

Expand Down
3 changes: 1 addition & 2 deletions unittests/find_container_traits_tester.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

from pygccxml import parser
from pygccxml import declarations
from pygccxml import utils


class Test(parser_test_case.parser_test_case_t):
Expand All @@ -30,7 +29,7 @@ def setUp(self):
self.global_ns = Test.global_ns

def __cmp_traits(self, typedef, expected, partial_name, key_type=None):
if utils.is_str(typedef):
if isinstance(typedef, str):
typedef = self.global_ns.typedef(typedef)
traits = declarations.find_container_traits(typedef)
self.assertTrue(
Expand Down