Skip to content

Commit acb496b

Browse files
authored
refactor Python API to be more pythonic - part 2 (#321)
make more API's more consistent with naming in python. The old naming is still possible, but causes a deprecation message.
1 parent 48ac9f8 commit acb496b

67 files changed

Lines changed: 609 additions & 471 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

python/src/addons/CompletionDictionaryCompiler.pyx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66

77
def __setitem__(self, key, value):
8-
self.Add(key, value)
8+
self.add(key, value)
99

1010

1111
def __exit__(self, type, value, traceback):
12-
self.Compile()
12+
self.compile()
1313

1414

15-
def Compile(self, *args):
15+
def compile(self, *args):
1616
if not args:
1717
with nogil:
1818
self.inst.get().Compile()
@@ -21,3 +21,15 @@
2121
cdef void* callback = <void*> args[0]
2222
with nogil:
2323
self.inst.get().Compile(progress_compiler_callback, callback)
24+
25+
def Compile(self, *args):
26+
return call_deprecated_method("Compile", "compile", self.compile, *args)
27+
28+
def Add(self, *args):
29+
return call_deprecated_method("Add", "add", self.add, *args)
30+
31+
def SetManifest(self, *args):
32+
return call_deprecated_method("SetManifest", "set_manifest", self.set_manifest, *args)
33+
34+
def WriteToFile(self, *args):
35+
return call_deprecated_method("WriteToFile", "write_to_file", self.write_to_file, *args)
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
3+
def Add(self, *args):
4+
return call_deprecated_method("Add", "add", self.add, *args)
5+
6+
def Merge(self, *args):
7+
return call_deprecated_method("Merge", "merge", self.merge, *args)
8+
9+
def SetManifest(self, *args):
10+
return call_deprecated_method("SetManifest", "set_manifest", self.set_manifest, *args)
11+
12+

python/src/addons/FloatVectorDictionaryCompiler.pyx

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66

77
def __setitem__(self, key, value):
8-
self.Add(key, value)
8+
self.add(key, value)
99

1010

1111
def __exit__(self, type, value, traceback):
12-
self.Compile()
12+
self.compile()
1313

1414

15-
def Compile(self, *args):
15+
def compile(self, *args):
1616
if not args:
1717
with nogil:
1818
self.inst.get().Compile()
@@ -22,3 +22,14 @@
2222
with nogil:
2323
self.inst.get().Compile(progress_compiler_callback, callback)
2424

25+
def Compile(self, *args):
26+
return call_deprecated_method("Compile", "compile", self.compile, *args)
27+
28+
def Add(self, *args):
29+
return call_deprecated_method("Add", "add", self.add, *args)
30+
31+
def SetManifest(self, *args):
32+
return call_deprecated_method("SetManifest", "set_manifest", self.set_manifest, *args)
33+
34+
def WriteToFile(self, *args):
35+
return call_deprecated_method("WriteToFile", "write_to_file", self.write_to_file, *args)
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
3+
def GetCompletions(self, *args):
4+
return call_deprecated_method("GetCompletions", "complete", self.complete, *args)

python/src/addons/Index.pyx

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
self.inst.get().Delete(key)
3838

39-
def Get (self, key, default = None):
39+
def get (self, key, default = None):
4040
"""Return the value for key if key is in the dictionary, else default."""
4141
if isinstance(key, unicode):
4242
key = key.encode('utf-8')
@@ -50,6 +50,9 @@
5050
py_result.inst = _r
5151
return py_result
5252

53+
def Get(self, *args):
54+
return call_deprecated_method("Get", "get", self.get, *args)
55+
5356
def __contains__(self, key):
5457
if isinstance(key, unicode):
5558
key = key.encode('utf-8')
@@ -72,7 +75,7 @@
7275
py_result.inst = _r
7376
return py_result
7477

75-
def MSet(self, list key_values ):
78+
def bulk_set(self, list key_values ):
7679
assert isinstance(key_values, list), 'arg in_0 wrong type'
7780
cdef shared_ptr[libcpp_vector[libcpp_pair[libcpp_utf8_string,libcpp_utf8_string]]] cpp_key_values = shared_ptr[libcpp_vector[libcpp_pair[libcpp_utf8_string,libcpp_utf8_string]]](new libcpp_vector[libcpp_pair[libcpp_utf8_string,libcpp_utf8_string]]())
7881
cdef libcpp_pair[libcpp_utf8_string, libcpp_utf8_string] cpp_kv
@@ -92,3 +95,21 @@
9295
cpp_key_values.get().push_back(cpp_kv)
9396

9497
self.inst.get().MSet(cpp_key_values)
98+
99+
def MSet(self, *args):
100+
return call_deprecated_method("MSet", "bulk_set", self.bulk_set, *args)
101+
102+
def Set(self, *args):
103+
return call_deprecated_method("Set", "set", self.set, *args)
104+
105+
def GetNear(self, *args):
106+
return call_deprecated_method("GetNear", "get_near", self.get_near, *args)
107+
108+
def GetFuzzy(self, *args):
109+
return call_deprecated_method("GetFuzzy", "get_fuzzy", self.get_fuzzy, *args)
110+
111+
def Delete(self, *args):
112+
return call_deprecated_method("Delete", "delete", self.delete, *args)
113+
114+
def Flush(self, *args):
115+
return call_deprecated_method("Flush", "flush", self.flush, *args)

python/src/addons/IntDictionaryCompiler.pyx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66

77
def __setitem__(self, key, value):
8-
self.Add(key, value)
8+
self.add(key, value)
99

1010

1111
def __exit__(self, type, value, traceback):
12-
self.Compile()
12+
self.compile()
1313

1414

15-
def Compile(self, *args):
15+
def compile(self, *args):
1616
if not args:
1717
with nogil:
1818
self.inst.get().Compile()
@@ -22,3 +22,15 @@
2222
with nogil:
2323
self.inst.get().Compile(progress_compiler_callback, callback)
2424

25+
def Compile(self, *args):
26+
return call_deprecated_method("Compile", "compile", self.compile, *args)
27+
28+
def Add(self, *args):
29+
return call_deprecated_method("Add", "add", self.add, *args)
30+
31+
def SetManifest(self, *args):
32+
return call_deprecated_method("SetManifest", "set_manifest", self.set_manifest, *args)
33+
34+
def WriteToFile(self, *args):
35+
return call_deprecated_method("WriteToFile", "write_to_file", self.write_to_file, *args)
36+

python/src/addons/IntDictionaryCompilerSmallData.pyx

Lines changed: 0 additions & 24 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
3+
def Add(self, *args):
4+
return call_deprecated_method("Add", "add", self.add, *args)
5+
6+
def Merge(self, *args):
7+
return call_deprecated_method("Merge", "merge", self.merge, *args)
8+
9+
def SetManifest(self, *args):
10+
return call_deprecated_method("SetManifest", "set_manifest", self.set_manifest, *args)
11+
12+

python/src/addons/JsonDictionaryCompiler.pyx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66

77
def __setitem__(self, key, value):
8-
self.Add(key, value)
8+
self.add(key, value)
99

1010

1111
def __exit__(self, type, value, traceback):
12-
self.Compile()
12+
self.compile()
1313

1414

15-
def Compile(self, *args):
15+
def compile(self, *args):
1616
if not args:
1717
with nogil:
1818
self.inst.get().Compile()
@@ -22,3 +22,15 @@
2222
with nogil:
2323
self.inst.get().Compile(progress_compiler_callback, callback)
2424

25+
def Compile(self, *args):
26+
return call_deprecated_method("Compile", "compile", self.compile, *args)
27+
28+
def Add(self, *args):
29+
return call_deprecated_method("Add", "add", self.add, *args)
30+
31+
def SetManifest(self, *args):
32+
return call_deprecated_method("SetManifest", "set_manifest", self.set_manifest, *args)
33+
34+
def WriteToFile(self, *args):
35+
return call_deprecated_method("WriteToFile", "write_to_file", self.write_to_file, *args)
36+

python/src/addons/JsonDictionaryCompilerSmallData.pyx

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)