Skip to content

Commit d25cfce

Browse files
xml_reflection: First step to enable deprecation of public access
1 parent 54e4155 commit d25cfce

File tree

4 files changed

+184
-112
lines changed

4 files changed

+184
-112
lines changed

src/urdf_parser_py/_xml_reflection.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# TODO(eacousineau): Move all symbols from `.xml_reflection` into here.
2+
from urdf_parser_py.xml_reflection.basics import *
3+
from urdf_parser_py.xml_reflection.core import *
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
# TODO(eacousineau): Deprecate public access.
12
from urdf_parser_py.xml_reflection.core import *

src/urdf_parser_py/xml_reflection/basics.py

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
1-
import string
2-
import yaml
1+
# TODO(eacousineau): Deprecate public access.
32
import collections
3+
import string
4+
# TODO(eacousineau): Leverage tfoote's PR.
5+
from xml.etree.ElementTree import ElementTree
6+
47
from lxml import etree
8+
import yaml
9+
10+
from urdf_parser_py import _now_private_property
11+
12+
__all__ = [
13+
"xml_string",
14+
"dict_sub",
15+
"node_add",
16+
"pfloat",
17+
"xml_children",
18+
"isstring",
19+
"to_yaml",
20+
"SelectiveReflection",
21+
"YamlReflection",
22+
# Backwards compatibility.
23+
"etree",
24+
]
25+
526

627
def xml_string(rootXml, addHeader=True):
728
# Meh
@@ -74,13 +95,15 @@ def to_yaml(obj):
7495

7596

7697
class SelectiveReflection(object):
77-
def get_refl_vars(self):
98+
def _get_refl_vars(self):
7899
return list(vars(self).keys())
79100

101+
get_refl_vars = _now_private_property('_get_refl_vars')
102+
80103

81104
class YamlReflection(SelectiveReflection):
82105
def to_yaml(self):
83-
raw = dict((var, getattr(self, var)) for var in self.get_refl_vars())
106+
raw = dict((var, getattr(self, var)) for var in self._get_refl_vars())
84107
return to_yaml(raw)
85108

86109
def __str__(self):

0 commit comments

Comments
 (0)