Skip to content

Inherit Function Docstrings and other metedata #4985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pcmoritz merged 2 commits into from
Jun 15, 2019
Merged

Inherit Function Docstrings and other metedata #4985

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
876a9a7
Use wraps to inherit function metadata
simon-mo Jun 14, 2019
6478c56
Format code
simon-mo Jun 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions python/ray/remote_function.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import copy
import logging
from functools import wraps

from ray.function_manager import FunctionDescriptor
import ray.signature
Expand Down Expand Up @@ -74,15 +75,18 @@ def __init__(self, function, num_cpus, num_gpus, resources,

self._last_driver_id_exported_for = None

# Override task.remote's signature and docstring
@wraps(function)
def _remote_proxy(*args, **kwargs):
return self._remote(args=args, kwargs=kwargs)

self.remote = _remote_proxy

def __call__(self, *args, **kwargs):
raise Exception("Remote functions cannot be called directly. Instead "
"of running '{}()', try '{}.remote()'.".format(
self._function_name, self._function_name))

def remote(self, *args, **kwargs):
"""This runs immediately when a remote function is called."""
return self._remote(args=args, kwargs=kwargs)

def _submit(self,
args=None,
kwargs=None,
Expand Down