Deprecate undocumented get_master() method

This method was never officially documented and used only as a workaround for
issue #53. It also returns an instance of the undocumented and scruffily
implemented Pipe class that I would prefer to keep internal.

Now that #53 has been fixed, this method can be removed from the unofficial
public API, but deprecate it just in case. If someone was using it then it
is still possible (although not supported) to access the `_pipe` property of
`_pty_native`.
This commit is contained in:
Leroy Hopson 2022-08-19 20:20:04 +12:00
parent 6cd5facb98
commit 41525959e1
No known key found for this signature in database
GPG key ID: D2747312A6DB51AA

View file

@ -173,6 +173,9 @@ func open(cols: int = DEFAULT_COLS, rows: int = DEFAULT_ROWS) -> Array:
func get_master():
push_warning(
"The method get_master() is deprecated and will be removed in a future version. If you really need to get the underlying Pipe of the pty, then you can access '_pty_native._pipe', but this is not supported and may change at any time."
)
return _pty_native.get_master()