private-attribute-cpp 2.0.6__tar.gz → 2.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. {private_attribute_cpp-2.0.6/private_attribute_cpp.egg-info → private_attribute_cpp-2.1.0}/PKG-INFO +3 -1
  2. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/README.md +2 -0
  3. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/private_attribute.cpp +144 -47
  4. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0/private_attribute_cpp.egg-info}/PKG-INFO +3 -1
  5. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/setup.py +1 -1
  6. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/tests/test_private_abc.py +5 -1
  7. private_attribute_cpp-2.1.0/tests/test_private_func.py +57 -0
  8. private_attribute_cpp-2.1.0/tests/test_private_inheritance.py +319 -0
  9. private_attribute_cpp-2.0.6/tests/test_private_func.py +0 -27
  10. private_attribute_cpp-2.0.6/tests/test_private_inheritance.py +0 -40
  11. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/LICENSE +0 -0
  12. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/MANIFEST.in +0 -0
  13. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/picosha2.h +0 -0
  14. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/private_attribute.pyi +0 -0
  15. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/private_attribute_cpp.egg-info/SOURCES.txt +0 -0
  16. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/private_attribute_cpp.egg-info/dependency_links.txt +0 -0
  17. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/private_attribute_cpp.egg-info/not-zip-safe +0 -0
  18. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/private_attribute_cpp.egg-info/top_level.txt +0 -0
  19. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/setup.cfg +0 -0
  20. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/tests/test_class_private_attrs.py +0 -0
  21. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/tests/test_private_attrs.py +0 -0
  22. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/tests/test_private_method.py +0 -0
  23. {private_attribute_cpp-2.0.6 → private_attribute_cpp-2.1.0}/tests/test_private_wrap.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: private_attribute_cpp
3
- Version: 2.0.6
3
+ Version: 2.1.0
4
4
  Summary: A Python package that provides a way to define private attributes in C++ implementation.
5
5
  Home-page: https://github.com/Locked-chess-official/private_attribute_cpp
6
6
  Author: HuangHaoHua
@@ -250,6 +250,8 @@ TypeError: Can't instantiate abstract class MyClass without an implementation fo
250
250
  - Don't use a decorator which will return the `_PrivateWrap` in `PrivateWrapProxy` which will raise `TypeError`.
251
251
  - One class defined in another class cannot use another class's private attribute.
252
252
  - One parent class defined an attribute which not in `__private_attrs__` or not a `PrivateAttrType` instance, the child class shouldn't contain the attribute in its `__private_attrs__`.
253
+ - Since 2.1.0: the code of a subclass can no longer access the private attributes of its parent classes - a parent's private attribute is only reachable from the parent's own code, or from a class that declares the same name in its own `__private_attrs__`.
254
+ - Since 2.1.0: if a subclass defines an attribute with the same name as a parent's private attribute, they are stored separately (instance attributes per declaring class, class-level attributes in `all_type_subclass_attr[parent][subclass]`). Class-level resolution is per-subject through the parent's code: reading the name on a subclass subject returns the subclass's own value, and the parent's own value is untouched. Such a same-name definition does NOT grant the subclass's own code access to the name.
253
255
  - CPython may change "tp_getattro", "tp_setattro" and so on when you change the attribute "\_\_getattribute\_\_", "\_\_setattr\_\_" and so on. If you are fear about it, you can use `ensure_type` to reset those tp slots. For the other metaclasses, you can use `ensure_metaclass` to reset those tp slots. Also, don't set those methods on these classes in your code.
254
256
  - `private_attribute.register_metaclass` must be called with the metaclass which supports weakref.
255
257
  - Don't set `__static_attributes__` in private attribute class, or it will be removed.
@@ -231,6 +231,8 @@ TypeError: Can't instantiate abstract class MyClass without an implementation fo
231
231
  - Don't use a decorator which will return the `_PrivateWrap` in `PrivateWrapProxy` which will raise `TypeError`.
232
232
  - One class defined in another class cannot use another class's private attribute.
233
233
  - One parent class defined an attribute which not in `__private_attrs__` or not a `PrivateAttrType` instance, the child class shouldn't contain the attribute in its `__private_attrs__`.
234
+ - Since 2.1.0: the code of a subclass can no longer access the private attributes of its parent classes - a parent's private attribute is only reachable from the parent's own code, or from a class that declares the same name in its own `__private_attrs__`.
235
+ - Since 2.1.0: if a subclass defines an attribute with the same name as a parent's private attribute, they are stored separately (instance attributes per declaring class, class-level attributes in `all_type_subclass_attr[parent][subclass]`). Class-level resolution is per-subject through the parent's code: reading the name on a subclass subject returns the subclass's own value, and the parent's own value is untouched. Such a same-name definition does NOT grant the subclass's own code access to the name.
234
236
  - CPython may change "tp_getattro", "tp_setattro" and so on when you change the attribute "\_\_getattribute\_\_", "\_\_setattr\_\_" and so on. If you are fear about it, you can use `ensure_type` to reset those tp slots. For the other metaclasses, you can use `ensure_metaclass` to reset those tp slots. Also, don't set those methods on these classes in your code.
235
237
  - `private_attribute.register_metaclass` must be called with the metaclass which supports weakref.
236
238
  - Don't set `__static_attributes__` in private attribute class, or it will be removed.
@@ -178,7 +178,11 @@ namespace {
178
178
  };
179
179
  static std::unordered_map<uintptr_t, std::unordered_map<uintptr_t, PyCodeObject*>> type_allowed_code_map;
180
180
  static std::unordered_map<uintptr_t, std::shared_ptr<std::shared_mutex>> all_type_mutex;
181
- static std::unordered_map<uintptr_t, PyObject*> type_need_call;
181
+ // private_func per type, stored with RAII ownership (PyObjectStorage
182
+ // INCREFs on assignment and DECREFs on destruction), so the map entry
183
+ // always owns exactly one reference - no dangling-pointer risk when the
184
+ // last external reference to the function disappears.
185
+ static std::unordered_map<uintptr_t, PyObjectStorage> type_need_call;
182
186
  static std::unordered_map<uintptr_t, std::unordered_set<TwoStringTuple>> all_type_attr_set;
183
187
  namespace {
184
188
  static std::unordered_map<uintptr_t, std::unordered_map<uintptr_t,
@@ -225,6 +229,19 @@ static uintptr_t type_set_attr_long_long_guidance(uintptr_t type, const std::str
225
229
  static bool type_private_attr(uintptr_t type, const std::string& name) noexcept;
226
230
  static FinalObject type_get_final_attr(uintptr_t type_id, const std::string& name) noexcept;
227
231
 
232
+ // Result of classifying an attribute access.
233
+ // - type_id: the node on the MRO chain (a class) whose code is currently running
234
+ // AND that declares the attribute as private. 0 means "no private owner".
235
+ // - allowed: false means the access must be denied (a private attribute touched
236
+ // from outside its declaring class, or from a subclass of it).
237
+ struct AttrClassifyResult
238
+ {
239
+ uintptr_t type_id = 0;
240
+ bool allowed = true;
241
+ };
242
+
243
+ static AttrClassifyResult attr_classify(uintptr_t typ_id, const std::string& name, PyCodeObject* code) noexcept;
244
+
228
245
  static bool
229
246
  is_class_code(uintptr_t typ_id, PyCodeObject* code) noexcept
230
247
  {
@@ -251,27 +268,67 @@ is_type_private(uintptr_t typ_id, const std::string& name) noexcept
251
268
  return false;
252
269
  }
253
270
 
254
- static bool
271
+ static AttrClassifyResult
255
272
  attr_classify(uintptr_t typ_id, const std::string& name, PyCodeObject* code) noexcept
256
273
  {
257
- if (is_class_code(typ_id, code)) {
258
- return true;
274
+ // Build the MRO chain: the actual class first, then its parents.
275
+ std::vector<uintptr_t> chain;
276
+ chain.push_back(typ_id);
277
+ if (::AllData::all_type_parent_id.find(typ_id) != ::AllData::all_type_parent_id.end()) {
278
+ auto& parent_ids = ::AllData::all_type_parent_id[typ_id];
279
+ chain.insert(chain.end(), parent_ids.begin(), parent_ids.end());
259
280
  }
260
- if (is_type_private(typ_id, name)) {
261
- return false;
281
+
282
+ // Find the class whose code is currently running (the code owner).
283
+ uintptr_t code_class = 0;
284
+ for (auto& node : chain) {
285
+ if (is_class_code(node, code)) {
286
+ code_class = node;
287
+ break;
288
+ }
262
289
  }
263
- if (::AllData::all_type_parent_id.find(typ_id) != ::AllData::all_type_parent_id.end()) {
264
- std::vector<uintptr_t> parent_ids = ::AllData::all_type_parent_id[typ_id];
265
- for (auto& parent_id : parent_ids) {
266
- if (is_class_code(parent_id, code)) {
267
- return true;
290
+
291
+ if (code_class == 0) {
292
+ // No class code was hit on the whole chain (e.g. the code belongs to a
293
+ // module-level function or an unrelated class): if the name is private
294
+ // to any class on the chain, deny the access.
295
+ for (auto& node : chain) {
296
+ if (is_type_private(node, name)) {
297
+ return {0, false};
268
298
  }
269
- if (is_type_private(parent_id, name)) {
270
- return false;
299
+ }
300
+ return {0, true};
301
+ }
302
+
303
+ if (is_type_private(code_class, name)) {
304
+ // Both conditions hold: the code is under this class AND the attribute
305
+ // is private to this very class -> allowed, and this node of the chain
306
+ // is the owner of the private attribute.
307
+ return {code_class, true};
308
+ }
309
+
310
+ // The code belongs to code_class but the name is not private to it: look
311
+ // upward (toward the base classes). If an ancestor declares the name
312
+ // private, a subclass is trying to touch a parent's private attribute.
313
+ // Note: a class-body definition reusing a parent's private name (a
314
+ // "shadow", stored separately in all_type_subclass_attr[parent][child])
315
+ // does NOT grant this class's code any access to the name.
316
+ bool found_code_class = false;
317
+ for (auto& node : chain) {
318
+ if (!found_code_class) {
319
+ if (node == code_class) {
320
+ found_code_class = true;
271
321
  }
322
+ continue;
323
+ }
324
+ if (is_type_private(node, name)) {
325
+ return {0, false};
272
326
  }
273
327
  }
274
- return true;
328
+
329
+ // Not private to the running class nor to any of its ancestors: treat it
330
+ // as a normal (non-private) attribute access.
331
+ return {0, true};
275
332
  }
276
333
 
277
334
  static std::string
@@ -437,13 +494,13 @@ static traverseproc get_need_tp_traverse(PyTypeObject* cls) noexcept;
437
494
  static inquiry get_need_tp_clear(PyTypeObject* cls) noexcept;
438
495
 
439
496
  static PyObject*
440
- id_getattr(const std::string& attr_name, PyObject* obj, PyObject* typ) noexcept
497
+ id_getattr(uintptr_t final_id, const std::string& attr_name, PyObject* obj, PyObject* typ) noexcept
441
498
  {
442
- uintptr_t obj_id, typ_id, final_id;
443
- obj_id = (uintptr_t) obj;
444
- typ_id = (uintptr_t) typ;
445
- final_id = type_set_attr_long_long_guidance(typ_id, attr_name);
446
- FinalObject final_object = type_get_final_attr(typ_id, attr_name);
499
+ uintptr_t obj_id = (uintptr_t) obj;
500
+ // Class-level fallback resolves per-subject (the instance's type): a
501
+ // subclass's separately-stored shadow of a parent's private name is
502
+ // visible through the per-subject walk in type_get_final_attr.
503
+ FinalObject final_object = type_get_final_attr((uintptr_t)typ, attr_name);
447
504
  if (final_object.status == -2) {
448
505
  return NULL;
449
506
  }
@@ -575,13 +632,11 @@ type_getattr(PyObject* typ, const std::string& attr_name) noexcept
575
632
  }
576
633
 
577
634
  static int
578
- id_setattr(const std::string& attr_name, PyObject* obj, PyObject* typ, PyObject* value) noexcept
635
+ id_setattr(uintptr_t final_id, const std::string& attr_name, PyObject* obj, PyObject* typ, PyObject* value) noexcept
579
636
  {
580
- uintptr_t obj_id, typ_id, final_id;
581
- obj_id = (uintptr_t) obj;
582
- typ_id = (uintptr_t) typ;
583
- final_id = type_set_attr_long_long_guidance(typ_id, attr_name);
584
- FinalObject final_object = type_get_final_attr(typ_id, attr_name);
637
+ uintptr_t obj_id = (uintptr_t) obj;
638
+ // Class-level fallback resolves per-subject (the instance's type).
639
+ FinalObject final_object = type_get_final_attr((uintptr_t)typ, attr_name);
585
640
  if (final_object.status == -2) {
586
641
  return -1;
587
642
  }
@@ -684,6 +739,8 @@ type_setattr(PyObject* typ, const std::string& attr_name, PyObject* value) noexc
684
739
  }
685
740
  return 0;
686
741
  } else {
742
+ // The accessed class is a subclass that stores its own value for a
743
+ // parent's private name separately: all_type_subclass_attr[final_id][typ_id].
687
744
  if (::AllData::all_type_subclass_attr.find(final_id) == ::AllData::all_type_subclass_attr.end()) {
688
745
  ::AllData::all_type_subclass_attr[final_id] = {};
689
746
  }
@@ -706,13 +763,11 @@ type_setattr(PyObject* typ, const std::string& attr_name, PyObject* value) noexc
706
763
  }
707
764
 
708
765
  static int
709
- id_delattr(const std::string& attr_name, PyObject* obj, PyObject* typ) noexcept
766
+ id_delattr(uintptr_t final_id, const std::string& attr_name, PyObject* obj, PyObject* typ) noexcept
710
767
  {
711
- uintptr_t obj_id, typ_id, final_id;
712
- obj_id = (uintptr_t) obj;
713
- typ_id = (uintptr_t) typ;
714
- final_id = type_set_attr_long_long_guidance(typ_id, attr_name);
715
- FinalObject final_object = type_get_final_attr(typ_id, attr_name);
768
+ uintptr_t obj_id = (uintptr_t) obj;
769
+ // Class-level fallback resolves per-subject (the instance's type).
770
+ FinalObject final_object = type_get_final_attr((uintptr_t)typ, attr_name);
716
771
  if (final_object.status == -2) {
717
772
  return -1;
718
773
  }
@@ -1281,14 +1336,21 @@ PrivateAttr_tp_getattro(PyObject* self, PyObject* name) noexcept
1281
1336
  std::string name_str = PyUnicode_AsUTF8(name);
1282
1337
  auto code = get_now_code();
1283
1338
  if (type_private_attr(type_id, name_str)) {
1284
- if (!code || !attr_classify(type_id, name_str, code)){
1339
+ if (!code) {
1285
1340
  Py_XDECREF(code);
1286
1341
  PyErr_SetString(PyExc_AttributeError, "private attribute");
1287
1342
  return NULL;
1288
- } else {
1289
- Py_XDECREF(code);
1290
- return id_getattr(name_str, self, (PyObject*)typ);
1291
1343
  }
1344
+ AttrClassifyResult classify = attr_classify(type_id, name_str, code);
1345
+ Py_XDECREF(code);
1346
+ if (!classify.allowed) {
1347
+ PyErr_SetString(PyExc_AttributeError, "private attribute");
1348
+ return NULL;
1349
+ }
1350
+ if (classify.type_id != 0) {
1351
+ return id_getattr(classify.type_id, name_str, self, (PyObject*)typ);
1352
+ }
1353
+ // owner is 0: not private for this access context -> normal attribute
1292
1354
  }
1293
1355
  Py_XDECREF(code);
1294
1356
  if (::AllData::all_type_getattro.find(type_id) != ::AllData::all_type_getattro.end()){
@@ -1313,17 +1375,24 @@ PrivateAttr_tp_setattro(PyObject* self, PyObject* name, PyObject* value) noexcep
1313
1375
  std::string name_str(c_name);
1314
1376
  auto code = get_now_code();
1315
1377
  if (type_private_attr(typ_id, name_str)) {
1316
- if (!code || !attr_classify(typ_id, name_str, code)){
1378
+ if (!code) {
1317
1379
  PyErr_SetString(PyExc_AttributeError, "private attribute");
1318
1380
  Py_XDECREF(code);
1319
1381
  return -1;
1320
- } else {
1321
- Py_XDECREF(code);
1382
+ }
1383
+ AttrClassifyResult classify = attr_classify(typ_id, name_str, code);
1384
+ Py_XDECREF(code);
1385
+ if (!classify.allowed) {
1386
+ PyErr_SetString(PyExc_AttributeError, "private attribute");
1387
+ return -1;
1388
+ }
1389
+ if (classify.type_id != 0) {
1322
1390
  if (!value) {
1323
- return id_delattr(name_str, self, (PyObject*)typ);
1391
+ return id_delattr(classify.type_id, name_str, self, (PyObject*)typ);
1324
1392
  }
1325
- return id_setattr(name_str, self, (PyObject*)typ, value);
1393
+ return id_setattr(classify.type_id, name_str, self, (PyObject*)typ, value);
1326
1394
  }
1395
+ // owner is 0: not private for this access context -> normal attribute
1327
1396
  }
1328
1397
  Py_XDECREF(code);
1329
1398
  if (::AllData::all_type_setattro.find(typ_id) != ::AllData::all_type_setattro.end()){
@@ -1796,6 +1865,10 @@ get_string_hash_tuple2(const std::string& name) noexcept
1796
1865
  static FinalObject
1797
1866
  type_get_final_attr(uintptr_t type_id, const std::string& name) noexcept
1798
1867
  {
1868
+ // type_id is the SUBJECT: the class whose attribute is being accessed.
1869
+ // The walk resolves per-subject: a subclass's separately stored value
1870
+ // (all_type_subclass_attr[parent][subclass]) shadows the parent's own
1871
+ // class-level value, satisfying class-level separate storage.
1799
1872
  TwoStringTuple hash_tuple = get_string_hash_tuple2(name);
1800
1873
  if (::AllData::all_type_attr_set.find(type_id) != ::AllData::all_type_attr_set.end()) {
1801
1874
  if (::AllData::all_type_attr_set[type_id].find(hash_tuple) != ::AllData::all_type_attr_set[type_id].end()) {
@@ -2084,6 +2157,8 @@ struct PrivateAttrCreationData
2084
2157
  std::unordered_set<std::string> private_attrs_vector_string;
2085
2158
  std::vector<uintptr_t> all_need_analyse_base;
2086
2159
  std::unordered_map<std::string, PyObjectStorage> need_remove_itself;
2160
+ // Class-body attributes whose name is private to a parent class: stored
2161
+ // separately in all_type_subclass_attr[parent][this class].
2087
2162
  std::unordered_map<uintptr_t, std::unordered_map<std::string, PyObjectStorage>> need_remove_subclass;
2088
2163
  PyObject* private_func = nullptr;
2089
2164
  PyObject* base_kwds = nullptr;
@@ -2365,6 +2440,9 @@ PrivateAttrType_preprocess(PyObject* args, PyObject* kwds, PrivateAttrCreationDa
2365
2440
  }
2366
2441
  uintptr_t need_remove_subclass_id = need_remove_to_subclass(attr_name);
2367
2442
  if (need_remove_subclass_id) {
2443
+ // The class body defines an attribute whose name is private to a
2444
+ // parent class. It is stored separately (class-level separate
2445
+ // storage) in all_type_subclass_attr[need_remove_subclass_id][this].
2368
2446
  if (data.need_remove_subclass.find(need_remove_subclass_id) == data.need_remove_subclass.end()) {
2369
2447
  data.need_remove_subclass[need_remove_subclass_id] = {};
2370
2448
  }
@@ -2661,6 +2739,10 @@ PrivateAttrType_postprocess(PyObject* new_type, PrivateAttrCreationData& data) n
2661
2739
  }
2662
2740
 
2663
2741
  if (data.private_func) {
2742
+ // PyObjectStorage::operator=(PyObject*) takes its own reference here;
2743
+ // data's reference is released by PrivateAttrCreationData::clear()
2744
+ // right after this, and the map entry's reference is released when the
2745
+ // entry is erased in PrivateAttrType_finalize.
2664
2746
  ::AllData::type_need_call[type_id] = data.private_func;
2665
2747
  }
2666
2748
 
@@ -2750,13 +2832,21 @@ PrivateAttrType_getattr(PyObject* cls, PyObject* name) noexcept
2750
2832
  std::string name_str = PyUnicode_AsUTF8(name);
2751
2833
  PyCodeObject* now_code = get_now_code();
2752
2834
  if (type_private_attr(typ_id, name_str)) {
2753
- if (!now_code || !attr_classify(typ_id, name_str, now_code)) {
2835
+ if (!now_code) {
2754
2836
  PyErr_SetString(PyExc_AttributeError, "private attribute");
2755
2837
  Py_XDECREF(now_code);
2756
2838
  return NULL;
2757
2839
  }
2840
+ AttrClassifyResult classify = attr_classify(typ_id, name_str, now_code);
2758
2841
  Py_XDECREF(now_code);
2759
- return type_getattr(cls, name_str);
2842
+ if (!classify.allowed) {
2843
+ PyErr_SetString(PyExc_AttributeError, "private attribute");
2844
+ return NULL;
2845
+ }
2846
+ if (classify.type_id != 0) {
2847
+ return type_getattr(cls, name_str);
2848
+ }
2849
+ // owner is 0: not private for this access context -> normal attribute
2760
2850
  }
2761
2851
  Py_XDECREF(now_code);
2762
2852
  PyTypeObject* base = Py_TYPE(cls)->tp_base;
@@ -3097,13 +3187,21 @@ PrivateAttrType_setattr(PyObject* cls, PyObject* name, PyObject* value) noexcept
3097
3187
  }
3098
3188
  PyCodeObject* now_code = get_now_code();
3099
3189
  if (type_private_attr(typ_id, name_str)) {
3100
- if (!now_code || !attr_classify(typ_id, name_str, now_code)) {
3190
+ if (!now_code) {
3101
3191
  PyErr_SetString(PyExc_AttributeError, "private attribute");
3102
3192
  Py_XDECREF(now_code);
3103
3193
  return -1;
3104
3194
  }
3195
+ AttrClassifyResult classify = attr_classify(typ_id, name_str, now_code);
3105
3196
  Py_XDECREF(now_code);
3106
- return type_setattr(cls, name_str, value);
3197
+ if (!classify.allowed) {
3198
+ PyErr_SetString(PyExc_AttributeError, "private attribute");
3199
+ return -1;
3200
+ }
3201
+ if (classify.type_id != 0) {
3202
+ return type_setattr(cls, name_str, value);
3203
+ }
3204
+ // owner is 0: not private for this access context -> normal attribute
3107
3205
  }
3108
3206
  Py_XDECREF(now_code);
3109
3207
  PyTypeObject* base = Py_TYPE(cls)->tp_base;
@@ -3133,8 +3231,7 @@ PrivateAttrType_finalize(PyObject* cls) noexcept
3133
3231
  ::AllData::type_allowed_code_map.erase(typ_id);
3134
3232
  }
3135
3233
  if (::AllData::type_need_call.find(typ_id) != ::AllData::type_need_call.end()) {
3136
- auto& need_call = ::AllData::type_need_call[typ_id];
3137
- Py_XDECREF(need_call);
3234
+ // erase() destroys the PyObjectStorage, which DECREFs private_func.
3138
3235
  ::AllData::type_need_call.erase(typ_id);
3139
3236
  }
3140
3237
  if (::AllData::type_attr_dict.find(typ_id) != ::AllData::type_attr_dict.end()) {
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: private_attribute_cpp
3
- Version: 2.0.6
3
+ Version: 2.1.0
4
4
  Summary: A Python package that provides a way to define private attributes in C++ implementation.
5
5
  Home-page: https://github.com/Locked-chess-official/private_attribute_cpp
6
6
  Author: HuangHaoHua
@@ -250,6 +250,8 @@ TypeError: Can't instantiate abstract class MyClass without an implementation fo
250
250
  - Don't use a decorator which will return the `_PrivateWrap` in `PrivateWrapProxy` which will raise `TypeError`.
251
251
  - One class defined in another class cannot use another class's private attribute.
252
252
  - One parent class defined an attribute which not in `__private_attrs__` or not a `PrivateAttrType` instance, the child class shouldn't contain the attribute in its `__private_attrs__`.
253
+ - Since 2.1.0: the code of a subclass can no longer access the private attributes of its parent classes - a parent's private attribute is only reachable from the parent's own code, or from a class that declares the same name in its own `__private_attrs__`.
254
+ - Since 2.1.0: if a subclass defines an attribute with the same name as a parent's private attribute, they are stored separately (instance attributes per declaring class, class-level attributes in `all_type_subclass_attr[parent][subclass]`). Class-level resolution is per-subject through the parent's code: reading the name on a subclass subject returns the subclass's own value, and the parent's own value is untouched. Such a same-name definition does NOT grant the subclass's own code access to the name.
253
255
  - CPython may change "tp_getattro", "tp_setattro" and so on when you change the attribute "\_\_getattribute\_\_", "\_\_setattr\_\_" and so on. If you are fear about it, you can use `ensure_type` to reset those tp slots. For the other metaclasses, you can use `ensure_metaclass` to reset those tp slots. Also, don't set those methods on these classes in your code.
254
256
  - `private_attribute.register_metaclass` must be called with the metaclass which supports weakref.
255
257
  - Don't set `__static_attributes__` in private attribute class, or it will be removed.
@@ -18,7 +18,7 @@ readme = open('README.md').read()
18
18
 
19
19
  setup(
20
20
  name='private_attribute_cpp',
21
- version='2.0.6',
21
+ version='2.1.0',
22
22
  author="HuangHaoHua",
23
23
  author_email="13140752715@example.com",
24
24
  description='A Python package that provides a way to define private attributes in C++ implementation.',
@@ -26,7 +26,9 @@ class MyClass(ABC, metaclass=PrivateAbcMeta):
26
26
  pass
27
27
 
28
28
  class ConcreteClass(MyClass):
29
- __private_attrs__ = ["_secret2"]
29
+ # 2.1.0: a subclass can no longer access a parent's private attribute.
30
+ # If it needs the same name, it declares its own -> stored separately.
31
+ __private_attrs__ = ["_secret1", "_secret2"]
30
32
 
31
33
  def __init__(self, secret1, secret2):
32
34
  self._secret1 = secret1
@@ -49,6 +51,8 @@ class TestPrivateAbc(unittest.TestCase):
49
51
  with self.assertRaises(AttributeError):
50
52
  MyClass._secret1
51
53
  self.assertEqual(MyClass.get_secret1(), 10)
54
+ # get_secret1 is MyClass's own code, so it reads MyClass's private
55
+ # attribute even when called through the subclass.
52
56
  self.assertEqual(ConcreteClass.get_secret1(), 10)
53
57
 
54
58
  if __name__ == '__main__':
@@ -0,0 +1,57 @@
1
+ import private_attribute
2
+ import unittest
3
+
4
+ def my_func(obj_id, attr):
5
+ return f"Object ID: {obj_id}, String: {attr}"
6
+
7
+ class MyClass(private_attribute.PrivateAttrBase, private_func=my_func):
8
+ __private_attrs__ = ["_secret"]
9
+ __slots__ = ["public_attr"]
10
+
11
+ def __init__(self, secret, public_attr):
12
+ self._secret = secret
13
+ self.public_attr = public_attr
14
+
15
+ def get_secret(self):
16
+ return self._secret
17
+
18
+ class TestPrivateFunc(unittest.TestCase):
19
+ def test_private_func(self):
20
+ obj = MyClass("12345", "public_value")
21
+ self.assertEqual(obj.get_secret(), "12345")
22
+ self.assertEqual(obj.public_attr, "public_value")
23
+ with self.assertRaises(AttributeError):
24
+ obj._secret
25
+
26
+ def test_private_func_local_function_gc(self):
27
+ # Regression: a class created with a LOCAL private_func must not leave
28
+ # a dangling pointer in type_need_call after the function is collected.
29
+ # Previously this crashed with a segfault in PrivateAttrType_finalize
30
+ # during gc.collect().
31
+ import gc
32
+
33
+ def local_func(obj_id, attr):
34
+ return f"local_{obj_id}_{attr}"
35
+
36
+ class LocalParent(private_attribute.PrivateAttrBase, private_func=local_func):
37
+ __private_attrs__ = ["_v"]
38
+
39
+ def __init__(self):
40
+ self._v = 1
41
+
42
+ def get_v(self):
43
+ return self._v
44
+
45
+ class LocalChild(LocalParent):
46
+ __private_attrs__ = []
47
+
48
+ obj = LocalChild()
49
+ self.assertEqual(obj.get_v(), 1)
50
+ del obj
51
+ # drop the local classes and the local function, then collect
52
+ del LocalChild, LocalParent, local_func
53
+ for _ in range(3):
54
+ gc.collect()
55
+
56
+ if __name__ == "__main__":
57
+ unittest.main()
@@ -0,0 +1,319 @@
1
+ import private_attribute
2
+ import unittest
3
+
4
+ class BaseClass(private_attribute.PrivateAttrBase):
5
+ __private_attrs__ = ["_value"]
6
+ __slots__ = []
7
+
8
+ def __init__(self, value):
9
+ super().__init__()
10
+ self._value = value
11
+
12
+ @property
13
+ def value(self):
14
+ return self._value
15
+
16
+
17
+ class SubClass(BaseClass):
18
+ __private_attrs__ = ["_other_value"]
19
+ __slots__ = []
20
+
21
+ def __init__(self, value, other_value):
22
+ super().__init__(value)
23
+ self._other_value = other_value
24
+
25
+ @property
26
+ def other_value(self):
27
+ return self._other_value
28
+
29
+
30
+ class TestPrivateInheritance(unittest.TestCase):
31
+ def test_private_inheritance(self):
32
+ obj = SubClass(1, 2)
33
+ self.assertEqual(obj.value, 1)
34
+ self.assertEqual(obj.other_value, 2)
35
+ with self.assertRaises(AttributeError):
36
+ obj._value
37
+ with self.assertRaises(AttributeError):
38
+ obj._other_value
39
+
40
+ def test_subclass_cannot_access_parent_private(self):
41
+ # 2.1.0: code of a subclass must not touch a parent's private attribute.
42
+ class Parent(private_attribute.PrivateAttrBase):
43
+ __private_attrs__ = ["_secret"]
44
+
45
+ def __init__(self):
46
+ self._secret = 1
47
+
48
+ class Child(Parent):
49
+ __private_attrs__ = []
50
+
51
+ def read_parent_secret(self):
52
+ return self._secret
53
+
54
+ def write_parent_secret(self):
55
+ self._secret = 2
56
+
57
+ obj = Child()
58
+ with self.assertRaises(AttributeError):
59
+ obj.read_parent_secret()
60
+ with self.assertRaises(AttributeError):
61
+ obj.write_parent_secret()
62
+
63
+ def test_same_name_instance_attrs_stored_separately(self):
64
+ # 2.1.0: subclass and parent may both declare the same private name;
65
+ # each class's code accesses its own storage.
66
+ class Parent(private_attribute.PrivateAttrBase):
67
+ __private_attrs__ = ["_value"]
68
+
69
+ def __init__(self, value):
70
+ self._value = value
71
+
72
+ def get_parent_value(self):
73
+ return self._value
74
+
75
+ class Child(Parent):
76
+ __private_attrs__ = ["_value"]
77
+
78
+ def __init__(self, value):
79
+ super().__init__(value) # writes Parent's _value
80
+ self._value = value * 10 # writes Child's _value
81
+
82
+ def get_child_value(self):
83
+ return self._value
84
+
85
+ obj = Child(3)
86
+ self.assertEqual(obj.get_parent_value(), 3)
87
+ self.assertEqual(obj.get_child_value(), 30)
88
+ with self.assertRaises(AttributeError):
89
+ obj._value
90
+
91
+ def test_same_name_class_attrs_stored_separately(self):
92
+ # A class-body attribute reusing a parent's private name is stored
93
+ # separately (all_type_subclass_attr[parent][child]) and resolves
94
+ # per-subject through the PARENT's code. It does NOT grant the
95
+ # subclass's own code any access to the name.
96
+ class Parent(private_attribute.PrivateAttrBase):
97
+ __private_attrs__ = ["_value"]
98
+ _value = 10
99
+
100
+ def get_value(self):
101
+ return self._value
102
+
103
+ class Child(Parent):
104
+ __private_attrs__ = []
105
+ _value = 20
106
+
107
+ def get_child_value(self):
108
+ return self._value
109
+
110
+ self.assertEqual(Parent().get_value(), 10)
111
+ obj = Child()
112
+ # parent's code resolves per-subject: the child's own value
113
+ self.assertEqual(obj.get_value(), 20)
114
+ # the subclass's own code is NOT allowed to touch the name
115
+ with self.assertRaises(AttributeError):
116
+ obj.get_child_value()
117
+ with self.assertRaises(AttributeError):
118
+ obj._value
119
+ with self.assertRaises(AttributeError):
120
+ Child._value
121
+
122
+ def test_same_name_class_attrs_write_separately(self):
123
+ # Writes through the parent's code go to the subject's own storage;
124
+ # the subclass's own code cannot write the name at all.
125
+ class Parent(private_attribute.PrivateAttrBase):
126
+ __private_attrs__ = ["_value"]
127
+ _value = 1
128
+
129
+ @classmethod
130
+ def set_value(cls, v):
131
+ cls._value = v
132
+
133
+ @classmethod
134
+ def get_value(cls):
135
+ return cls._value
136
+
137
+ class Child(Parent):
138
+ __private_attrs__ = []
139
+ _value = 2
140
+
141
+ @classmethod
142
+ def set_own(cls, v):
143
+ cls._value = v
144
+
145
+ self.assertEqual(Parent.get_value(), 1)
146
+ self.assertEqual(Child.get_value(), 2)
147
+ # parent's classmethod called on the child writes the child's own storage
148
+ Child.set_value(99)
149
+ self.assertEqual(Child.get_value(), 99)
150
+ self.assertEqual(Parent.get_value(), 1)
151
+ # the subclass's own code cannot write the parent's private name
152
+ with self.assertRaises(AttributeError):
153
+ Child.set_own(7)
154
+ self.assertEqual(Child.get_value(), 99)
155
+ # parent's own storage still writable through the parent
156
+ Parent.set_value(5)
157
+ self.assertEqual(Parent.get_value(), 5)
158
+ self.assertEqual(Child.get_value(), 99)
159
+
160
+ def test_parent_code_still_works_on_subclass_instance(self):
161
+ # Parent's own methods keep working on subclass instances.
162
+ class Parent(private_attribute.PrivateAttrBase):
163
+ __private_attrs__ = ["_value"]
164
+
165
+ def __init__(self, value):
166
+ self._value = value
167
+
168
+ def get_value(self):
169
+ return self._value
170
+
171
+ class Child(Parent):
172
+ __private_attrs__ = ["_other"]
173
+
174
+ def __init__(self, value, other):
175
+ super().__init__(value)
176
+ self._other = other
177
+
178
+ def get_other(self):
179
+ return self._other
180
+
181
+ obj = Child(5, 6)
182
+ self.assertEqual(obj.get_value(), 5)
183
+ self.assertEqual(obj.get_other(), 6)
184
+
185
+ def test_multi_level_inheritance(self):
186
+ # A private attribute is only reachable from the code of the class
187
+ # that declares it - not from any of its subclasses.
188
+ class GrandParent(private_attribute.PrivateAttrBase):
189
+ __private_attrs__ = ["_g"]
190
+
191
+ def __init__(self):
192
+ self._g = 1
193
+
194
+ def get_g(self):
195
+ return self._g
196
+
197
+ class Parent(GrandParent):
198
+ __private_attrs__ = ["_p"]
199
+
200
+ def __init__(self):
201
+ super().__init__()
202
+ self._p = 2
203
+
204
+ def get_p(self):
205
+ return self._p
206
+
207
+ def try_grandparent_private(self):
208
+ return self._g
209
+
210
+ class Child(Parent):
211
+ __private_attrs__ = []
212
+
213
+ def try_parent_private(self):
214
+ return self._p
215
+
216
+ def try_grandparent_private(self):
217
+ return self._g
218
+
219
+ obj = Child()
220
+ self.assertEqual(obj.get_g(), 1)
221
+ self.assertEqual(obj.get_p(), 2)
222
+ with self.assertRaises(AttributeError):
223
+ obj.try_parent_private()
224
+ with self.assertRaises(AttributeError):
225
+ obj.try_grandparent_private()
226
+ with self.assertRaises(AttributeError):
227
+ Parent().try_grandparent_private()
228
+
229
+ def test_multiple_inheritance(self):
230
+ class Left(private_attribute.PrivateAttrBase):
231
+ __private_attrs__ = ["_value"]
232
+
233
+ def __init__(self):
234
+ self._value = "left"
235
+
236
+ def get_value(self):
237
+ return self._value
238
+
239
+ class Right(private_attribute.PrivateAttrBase):
240
+ __private_attrs__ = ["_value"]
241
+
242
+ def __init__(self):
243
+ self._value = "right"
244
+
245
+ def get_value(self):
246
+ return self._value
247
+
248
+ class Both(Left, Right):
249
+ __private_attrs__ = ["_value"]
250
+
251
+ def __init__(self):
252
+ Left.__init__(self)
253
+ Right.__init__(self)
254
+ self._value = "both"
255
+
256
+ def get_value(self):
257
+ return self._value
258
+
259
+ obj = Both()
260
+ self.assertEqual(Left.get_value(obj), "left")
261
+ self.assertEqual(Right.get_value(obj), "right")
262
+ self.assertEqual(obj.get_value(), "both")
263
+ with self.assertRaises(AttributeError):
264
+ obj._value
265
+
266
+ def test_private_func_with_inheritance(self):
267
+ def gen(obj_id, attr_name):
268
+ return f"<{attr_name}@{obj_id}>"
269
+
270
+ class Parent(private_attribute.PrivateAttrBase, private_func=gen):
271
+ __private_attrs__ = ["_value"]
272
+
273
+ def __init__(self, value):
274
+ self._value = value
275
+
276
+ def get_value(self):
277
+ return self._value
278
+
279
+ class Child(Parent):
280
+ __private_attrs__ = ["_value"]
281
+
282
+ def __init__(self, value):
283
+ super().__init__(value)
284
+ self._value = value * 2
285
+
286
+ def get_value(self):
287
+ return self._value
288
+
289
+ obj = Child(4)
290
+ self.assertEqual(Parent.get_value(obj), 4)
291
+ self.assertEqual(obj.get_value(), 8)
292
+
293
+ def test_class_level_del_from_own_code(self):
294
+ class Parent(private_attribute.PrivateAttrBase):
295
+ __private_attrs__ = ["_value"]
296
+ _value = 1
297
+
298
+ @classmethod
299
+ def del_value(cls):
300
+ del cls._value
301
+
302
+ @classmethod
303
+ def set_value(cls, v):
304
+ cls._value = v
305
+
306
+ @classmethod
307
+ def get_value(cls):
308
+ return cls._value
309
+
310
+ self.assertEqual(Parent.get_value(), 1)
311
+ Parent.del_value()
312
+ with self.assertRaises(AttributeError):
313
+ Parent.get_value()
314
+ # setting again works after deletion
315
+ Parent.set_value(99)
316
+ self.assertEqual(Parent.get_value(), 99)
317
+
318
+ if __name__ == "__main__":
319
+ unittest.main()
@@ -1,27 +0,0 @@
1
- import private_attribute
2
- import unittest
3
-
4
- def my_func(obj_id, attr):
5
- return f"Object ID: {obj_id}, String: {attr}"
6
-
7
- class MyClass(private_attribute.PrivateAttrBase, private_func=my_func):
8
- __private_attrs__ = ["_secret"]
9
- __slots__ = ["public_attr"]
10
-
11
- def __init__(self, secret, public_attr):
12
- self._secret = secret
13
- self.public_attr = public_attr
14
-
15
- def get_secret(self):
16
- return self._secret
17
-
18
- class TestPrivateFunc(unittest.TestCase):
19
- def test_private_func(self):
20
- obj = MyClass("12345", "public_value")
21
- self.assertEqual(obj.get_secret(), "12345")
22
- self.assertEqual(obj.public_attr, "public_value")
23
- with self.assertRaises(AttributeError):
24
- obj._secret
25
-
26
- if __name__ == "__main__":
27
- unittest.main()
@@ -1,40 +0,0 @@
1
- import private_attribute
2
- import unittest
3
-
4
- class BaseClass(private_attribute.PrivateAttrBase):
5
- __private_attrs__ = ["_value"]
6
- __slots__ = []
7
-
8
- def __init__(self, value):
9
- super().__init__()
10
- self._value = value
11
-
12
- class SubClass(BaseClass):
13
- __private_attrs__ = ["_other_value"]
14
- __slots__ = []
15
-
16
- def __init__(self, value, other_value):
17
- super().__init__(value)
18
- self._other_value = other_value
19
-
20
- @property
21
- def value(self):
22
- return self._value
23
-
24
- @property
25
- def other_value(self):
26
- return self._other_value
27
-
28
-
29
- class TestPrivateInheritance(unittest.TestCase):
30
- def test_private_inheritance(self):
31
- obj = SubClass(1, 2)
32
- self.assertEqual(obj.value, 1)
33
- self.assertEqual(obj.other_value, 2)
34
- with self.assertRaises(AttributeError):
35
- obj._value
36
- with self.assertRaises(AttributeError):
37
- obj._other_value
38
-
39
- if __name__ == "__main__":
40
- unittest.main()