Skip to content

Commit 92e7264

Browse files
authored
Add aliases to resolve discrepancy in naming (#36)
1 parent 5332935 commit 92e7264

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Changelog
55
Changes in version 1.1.0
66
------------------------
77
- ``ExplainCollection`` now importable from top level like so: ``from pymongoexplain import ExplainCollection``
8+
- Added aliases so that now both ``ExplainCollection`` and ``ExplainableCollection`` are importable
89

910
Changes in version 1.0.0
1011
------------------------

pymongoexplain/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
from pymongoexplain.explainable_collection import ExplainCollection
15+
from .explainable_collection import ExplainableCollection, ExplainCollection
16+

pymongoexplain/explainable_collection.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
Document = Union[dict, SON]
2626

2727

28-
class ExplainCollection():
28+
class ExplainableCollection():
2929
def __init__(self, collection):
3030
self.collection = collection
3131
self.last_cmd_payload = None
@@ -186,5 +186,5 @@ def replace_one(self, filter: Document, replacement: Document,
186186
return self._explain_command(command)
187187

188188

189-
190-
189+
# Alias
190+
ExplainCollection = ExplainableCollection

test/test_collection.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,5 +213,11 @@ def test_cli_tool(self):
213213
self.assertNotEqual(res.stdout, "")
214214
self.assertTrue(res.returncode == 0)
215215

216+
def test_imports(self):
217+
from pymongoexplain import ExplainCollection
218+
from pymongoexplain import ExplainableCollection
219+
self.assertEqual(ExplainableCollection, ExplainCollection)
220+
221+
216222
if __name__ == '__main__':
217223
unittest.main()

0 commit comments

Comments
 (0)