Repository: ray-project/ray
File: python/ray/data/_internal/util.py (Python)

Code before:
    avoid OOMs), those tasks become unschedulable. Detect this upfront and
    raise a clear error with remediation steps.
    """

    # Ray defaults to reserving 1 CPU per task when num_cpus isn't provided.
    num_cpus = ray_remote_args.get("num_cpus", 1)
    num_gpus = ray_remote_args.get("num_gpus", 0)
    memory = ray_remote_args.get("memory", 0)

    required_resources: Dict[str, float] = {}
    if num_cpus > 0:
        required_resources["CPU"] = float(num_cpus)
    if num_gpus > 0:
        required_resources["GPU"] = float(num_gpus)
    if memory > 0:
        required_resources["memory"] = float(memory)

    # Include any additional custom resources requested.
    custom_resources = ray_remote_args.get("resources")
    if custom_resources is None:
        custom_resources = {}
    for name, amount in custom_resources.items():
        if amount is None:
            continue
        if amount > 0:
            required_resources[name] = float(amount)

    # If there are no positive resource requirements, the task can run on a
    # zero-resource head node (e.g., num_cpus=0 opt-out), so nothing to check.
    if not required_resources:
        return

    head_node = next(
        (
            node
            for node in ray.nodes()
            if node.get("Alive")
            and "node:__internal_head__" in node.get("Resources", {})
        ),
        None,
    )
    if not head_node:
        # The head node metadata is unavailable (e.g., during shutdown). Fall back
        # to the default behavior and let Ray surface its own error.
        return

    head_resources = head_node.get("Resources", {})
    insufficient = {
        name: (req, head_resources.get(name, 0.0))
        for name, req in required_resources.items()
        if head_resources.get(name, 0.0) < req

Review comment (suggestion):
Do you know if `amount` can be a `str`, like `"1.2"` ? I'm wondering if we should do something like this
```suggestion
        amount = float(amount) # will raise error if not convertible, but at least we surface the error
        if not amount:
            required_resources[name] = amount
```

Code after:
    *,
    message: str,
    pattern: str,
    insert_after: bool = True,
    directive: Optional[str] = None,
    skip_matches: int = 0,
) -> str:
    if "\n" in message:
        raise ValueError(
            "message shouldn't contain any newlines, since this function will insert "
            f"its own linebreaks when text wrapping: {message}"
        )

    doc = obj.__doc__.strip()
    if not doc:
        doc = ""

    if pattern == "" and insert_after:
        # Empty pattern + insert_after means that we want to append the message to the
        # end of the docstring.
        head = doc
        tail = ""
    else:
        tail = doc
        i = tail.find(pattern)
        skip_matches_left = skip_matches
        while i != -1:
            if insert_after:
                # Set offset to the first character after the pattern.
                offset = i + len(pattern)
            else:
                # Set offset to the first character in the matched line.
                offset = tail[:i].rfind("\n") + 1
            head = tail[:offset]
            tail = tail[offset:]
            skip_matches_left -= 1
            if skip_matches_left <= 0:
                break
            elif not insert_after:
                # Move past the found pattern, since we're skipping it.
                tail = tail[i - offset + len(pattern) :]
            i = tail.find(pattern)
        else:
            raise ValueError(
                f"Pattern {pattern} not found after {skip_matches} skips in docstring "
                f"{doc}"
            )
    # Get indentation of the to-be-inserted text.
    after_lines = list(filter(bool, tail.splitlines()))
    if len(after_lines) > 0:
        lines = after_lines