compas-dev / compas-dev/compas

Data.guid - mismatch in documentation and actual behaviour

Aperta
#1,055 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
386
Fork
122
Merge medio
11g 46m
PR unite (30g)
1

Descrizione

**Describe the bug**
The [documentation ](https://compas.dev/compas/latest/api/generated/compas.data.Data.html#compas.data.Data) states that the `guid` attribute in `Data` is a _"The globally unique identifier of the object."_
However, for example, when creating a `deepcopy()` of an object of a child class of Data, a rather confusing behaviour can be observed:

**To Reproduce**
```
from compas.geometry import Point
from copy import deepcopy()
p1 = Point(0,0,0)
p2 = deepcopy(p1)
print(p1.guid==p2.guid)
>>> True
print(p1.guid is p2.guid)
>>> False
```

**Expected behavior**
Probably expecting a behaviour returning `False` in both comparisons.
Otherwise suggest to mention that this is not the case in the documentation.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla documentazione di compas.data.Data e dalla riproduzione con deepcopy che utilizza compas.geometry.Point mostrata nell’issue. Verifica il significato documentato di guid rispetto al comportamento di uguaglianza osservato, quindi aggiorna l’implementazione o la documentazione in modo che il comportamento e la descrizione siano coerenti, aggiungendo un controllo di regressione per l’esempio.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
data
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.