Skip to content

Commit

Permalink
Stop warning that macOS support is experimental
Browse files Browse the repository at this point in the history
Previously this warning would be printed each time a `Tracker` was
constructed, which caused a lot of noise when `pytest-memray` was being
used, since it creates one `Tracker` per pytest test. Since we haven't
heard any reports from users of any cases where things are actually
broken on macOS, and since our documentation lists all of the known
limitations in considerable detail, we've decided to stop considering
macOS support to be experimental, and to drop the warning.

Signed-off-by: Matt Wozniski <mwozniski@bloomberg.net>
  • Loading branch information
godlygeek authored and pablogsal committed Nov 23, 2022
1 parent 2449085 commit f9fbe27
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/supported_environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Supported operating systems

You will have the best Memray experience on Linux.

We have experimental support for macOS 11 or newer. We cannot support older
We also support macOS 11 or newer. We cannot support older
macOS versions, as they don't provide a C++17 compatible runtime. Although all
features work on macOS, the way that macOS applications and Python libraries
are typically distributed often results in subpar native stacks on Mac. See
Expand Down
1 change: 1 addition & 0 deletions news/194.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Memray is now fully supported on macOS, and the warnings that macOS support is experimental have been dropped.
8 changes: 0 additions & 8 deletions src/memray/_memray.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -367,14 +367,6 @@ cdef class Tracker:
else:
raise TypeError("destination must be a SocketDestination or FileDestination")

def __init__(self, object file_name=None, *, object destination=None,
bool native_traces=False, unsigned int memory_interval_ms = 10,
bool follow_fork=False, bool trace_python_allocators=False):
if sys.platform == "darwin":
pprint(":warning: [bold red] Memray support in MacOS is still experimental [/]:warning:", file=sys.stderr)
pprint("[yellow]Please report any issues at https://github.com/bloomberg/memray/issues[/]", file=sys.stderr)
pprint("", file=sys.stderr)

def __cinit__(self, object file_name=None, *, object destination=None,
bool native_traces=False, unsigned int memory_interval_ms = 10,
bool follow_fork=False, bool trace_python_allocators=False):
Expand Down

0 comments on commit f9fbe27

Please sign in to comment.