6971065238

Committed 23 Nov 2023 02:31PM UTC coverage: 75.338% (-0.1%) from 75.449%

Build # 6971065238

Build Type

Pull #1979

github

Committed by

web-flow

Commit Message

Merge 4ce32ce35 into a62130685

Pull Request Pull Request #1979: Cleanup image views

Run Details

1836 of 2898 branches covered (0.0%)

Branch coverage included in aggregate %.

29 of 38 new or added lines in 9 files covered. (76.32%)

25 existing lines in 1 file now uncovered.

8972 of 11448 relevant lines covered (78.37%)

0.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.1

/mantidimaging/core/utility/leak_tracker.py

# Copyright (C) 2023 ISIS Rutherford Appleton Laboratory UKRI
# SPDX - License - Identifier: GPL-3.0-or-later
from __future__ import annotations
import gc
import sys
import traceback
import weakref
from types import FunctionType
from typing import NamedTuple, List, Set, Iterable

from numpy import ndarray


class ItemInfo(NamedTuple):
    ref: weakref.ref
    msg: str
    created: List[str]


def obj_to_string(obj, relative=None) -> str:
    """Shows object type, id and extra info for some classes"""
    extra_info = ""
    if isinstance(obj, dict) and relative is not None:
        keys = {k for k, v in obj.items() if v is relative}
        extra_info += f" keys={keys}"

    try:
        if hasattr(obj, "name"):
            extra_info += f" obj.name={obj.name}"

        if hasattr(obj, "id"):
            extra_info += f" obj.id={obj.id}"
    except RuntimeError as e:
        # Can happen with a deleted QWidget
        extra_info += str(e)

    if isinstance(obj, ndarray):
        extra_info += f" ndarray: {obj.shape} {obj.dtype}"

    if isinstance(obj, FunctionType):
        extra_info += f" function: {obj}"

    return f"{type(obj)} pyid={id(obj)} {extra_info}"


def find_owners(obj, depth: int, path: List[str] | None = None, ignore: Set[int] | None = None) -> List[List[str]]:
    """Recursively track though references to objects and return a list of routes"""
    all_routes = []
    if path is None:
        path = [obj_to_string(obj)]
    if ignore is None:
        ignore = set()
    ignore.add(id(sys._getframe()))
    ignore.add(id(path))
    ignore.add(id(obj))

    new_refs = [r for r in gc.get_referrers(obj) if id(r) not in ignore]
    ignore.add(id(new_refs))
    if len(new_refs) == 0:
        all_routes.append(path)
    for owner in new_refs:
        if type(owner).__name__ in ['frame', 'list_iterator']:
            continue
        route = [obj_to_string(owner, obj)] + path
        ignore.add(id(route))
        if depth > 0:
            new_routes = find_owners(owner, depth - 1, route, ignore)
            all_routes.extend(new_routes)
        else:
            all_routes.append(route)

    return all_routes


class LeakTracker:
    """
    Track object to debug why large objects are still referenced.

    All objects of interest should be added in their constructor. The pretty_print() method can be called later, so see
    some information about which of the objects are alive.
    """

    def __init__(self):
        self.tracked_objects = []

    def add(self, item, msg=""):
        created = traceback.format_stack()[:-1]
        item_info = ItemInfo(weakref.ref(item), msg, created)
        self.tracked_objects.append(item_info)

    def clear(self) -> None:
        self.tracked_objects.clear()

    def live_objects(self) -> Iterable[ItemInfo]:
        return (item for item in self.tracked_objects if item.ref() is not None)

    def count(self) -> int:
        return sum(1 for _ in self.live_objects())

    def pretty_print(self, debug_init=False, debug_owners=False, trace_depth=5, output=sys.stdout) -> None:
        for item_info in self.live_objects():
            item = item_info.ref()
            print(" Object:", obj_to_string(item_info.ref()), file=output)
            print(f"  {item_info.msg=}", file=output)
            if debug_init:
                print(" Created at:", file=output)
                for line in item_info.created[-trace_depth:]:
                    print("\t", line.strip(), file=output)
                print(file=output)

            if debug_owners:
                print(" Ownership:", file=output)
                routes = find_owners(item, trace_depth)
                for route in routes:
                    for step in route:
                        print("\t", step, file=output)
                    print(file=output)
            print(file=output)


leak_tracker = LeakTracker()

1	# Copyright (C) 2023 ISIS Rutherford Appleton Laboratory UKRI
2	# SPDX - License - Identifier: GPL-3.0-or-later
3	from __future__ import annotations	1✔
4	import gc	1✔
5	import sys	1✔
6	import traceback	1✔
7	import weakref	1✔
8	from types import FunctionType	1✔
9	from typing import NamedTuple, List, Set, Iterable	1✔
10
11	from numpy import ndarray	1✔
12
13
14	class ItemInfo(NamedTuple):	1✔
15	ref: weakref.ref	1✔
16	msg: str	1✔
17	created: List[str]	1✔
18
19
20	def obj_to_string(obj, relative=None) -> str:	1✔
21	"""Shows object type, id and extra info for some classes"""
22	extra_info = ""	1✔
23	if isinstance(obj, dict) and relative is not None:	1✔
24	keys = {k for k, v in obj.items() if v is relative}	1✔
25	extra_info += f" keys={keys}"	1✔
26
27	try:	1✔
28	if hasattr(obj, "name"):	1!
29	extra_info += f" obj.name={obj.name}"	×
30
31	if hasattr(obj, "id"):	1!
32	extra_info += f" obj.id={obj.id}"	×
33	except RuntimeError as e:	×
34	# Can happen with a deleted QWidget
35	extra_info += str(e)	×
36
37	if isinstance(obj, ndarray):	1!
38	extra_info += f" ndarray: {obj.shape} {obj.dtype}"	×
39
40	if isinstance(obj, FunctionType):	1!
NEW 41	extra_info += f" function: {obj}"	×
42
43	return f"{type(obj)} pyid={id(obj)} {extra_info}"	1✔
44
45
46	def find_owners(obj, depth: int, path: List[str] \| None = None, ignore: Set[int] \| None = None) -> List[List[str]]:	1✔
47	"""Recursively track though references to objects and return a list of routes"""
48	all_routes = []	1✔
49	if path is None:	1✔
50	path = [obj_to_string(obj)]	1✔
51	if ignore is None:	1✔
52	ignore = set()	1✔
53	ignore.add(id(sys._getframe()))	1✔
54	ignore.add(id(path))	1✔
55	ignore.add(id(obj))	1✔
56
57	new_refs = [r for r in gc.get_referrers(obj) if id(r) not in ignore]	1✔
58	ignore.add(id(new_refs))	1✔
59	if len(new_refs) == 0:	1✔
60	all_routes.append(path)	1✔
61	for owner in new_refs:	1✔
62	if type(owner).__name__ in ['frame', 'list_iterator']:	1!
63	continue	×
64	route = [obj_to_string(owner, obj)] + path	1✔
65	ignore.add(id(route))	1✔
66	if depth > 0:	1!
67	new_routes = find_owners(owner, depth - 1, route, ignore)	1✔
68	all_routes.extend(new_routes)	1✔
69	else:
70	all_routes.append(route)	×
71
72	return all_routes	1✔
73
74
75	class LeakTracker:	1✔
76	"""
77	Track object to debug why large objects are still referenced.
78
79	All objects of interest should be added in their constructor. The pretty_print() method can be called later, so see
80	some information about which of the objects are alive.
81	"""
82
83	def __init__(self):	1✔
84	self.tracked_objects = []	1✔
85
86	def add(self, item, msg=""):	1✔
87	created = traceback.format_stack()[:-1]	1✔
88	item_info = ItemInfo(weakref.ref(item), msg, created)	1✔
89	self.tracked_objects.append(item_info)	1✔
90
91	def clear(self) -> None:	1✔
92	self.tracked_objects.clear()	×
93
94	def live_objects(self) -> Iterable[ItemInfo]:	1✔
95	return (item for item in self.tracked_objects if item.ref() is not None)	1✔
96
97	def count(self) -> int:	1✔
98	return sum(1 for _ in self.live_objects())	1✔
99
100	def pretty_print(self, debug_init=False, debug_owners=False, trace_depth=5, output=sys.stdout) -> None:	1✔
101	for item_info in self.live_objects():	1✔
102	item = item_info.ref()	1✔
103	print(" Object:", obj_to_string(item_info.ref()), file=output)	1✔
104	print(f" {item_info.msg=}", file=output)	1✔
105	if debug_init:	1✔
106	print(" Created at:", file=output)	1✔
107	for line in item_info.created[-trace_depth:]:	1✔
108	print("\t", line.strip(), file=output)	1✔
109	print(file=output)	1✔
110
111	if debug_owners:	1✔
112	print(" Ownership:", file=output)	1✔
113	routes = find_owners(item, trace_depth)	1✔
114	for route in routes:	1✔
115	for step in route:	1✔
116	print("\t", step, file=output)	1✔
117	print(file=output)	1✔
118	print(file=output)	1✔
119
120
121	leak_tracker = LeakTracker()	1✔

mantidproject / mantidimaging / 6971065238

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous