Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Distinguish unresolved from resolved-empty required resources

Ouverte
#217 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
42/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Calme
Stack technique
python
Domaine
api

Piste de recherche

Commencez par lire les APIs request.get_required_resource et get_required_resources ainsi que leurs docstrings, puis comparez le comportement analogue de require_schema/get_required_schema. Définissez les cas pris en charge unresolved, absent et present, et confirmez la forme d’API choisie avec des tests ; le travail est terminé lorsque les appelants peuvent distinguer ces états sans dupliquer les vérifications d’appartenance.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement
What problem are you facing?

request.get_required_resource (and get_required_resources) returns None/[] in two semantically different cases: the requirement hasn't been resolved by Crossplane yet, and the requirement resolved but matched nothing. The only way to tell them apart is to also check name in req.required_resources, which the get_required_resources docstring documents as a caveat the caller must handle by hand.

This distinction matters whenever a function gates on an external resource. "Not resolved yet" is transient — wait and let Crossplane re-call. "Resolved, matched nothing" is a real state — the resource was deleted, or its reference is a typo — and usually wants a different response (e.g. a warning, or holding steady rather than waiting). Functions end up reimplementing the same in-then-get dance. We hit it twice in one project: once gating a hydration Job on an auth Secret, and once gating replica placement on a referenced cache being resolvable.

How could this Function help solve your problem?

A small helper that classifies a required resource into the three states, so callers don't each re-derive it from the in check. Roughly:

class Resolution(enum.Enum):
    UNRESOLVED = "unresolved"  # Crossplane hasn't fetched it yet (key absent)
    ABSENT     = "absent"      # resolved, but nothing matched
    PRESENT    = "present"     # resolved and found

def resolve_required(req, name) -> tuple[Resolution, dict | None]: ...

A list variant (and possibly the same for require_schema/get_required_schema, which has the analogous distinction) would round it out. Naming/placement and whether this is an enum vs. a small result type are open — happy to send a PR once there's a preferred shape.

Langage dominant
Python
Étoiles
12
Forks
15
Merge moyen
1 j 12 h
PR mergées (30 j)
7

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de crossplane/function-sdk-python

Toutes les issues de crossplane/function-sdk-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.