Un notebook trimis altcuiva ar trebui să includă cerințele de pachete
Cerințele incluse de marimo fac notebookul mai ușor de predat. Separați contractul de pachete de datele, bibliotecile de sistem și datele de acces necesare.
De 
Paul. Limbaje și framework-uri
Un notebook predat altei persoane ar trebui să arate explicit de ce pachete are nevoie. Altfel, destinatarul primește o muncă de investigație înainte să ajungă la analiză. Păstrarea cerințelor în notebook poate clarifica mult o predare restrânsă. Nu poate însă conserva, singură, datele și mediul de operare care au produs rezultatul.
Funcționalitatea marimo din septembrie 2024 este utilă tocmai în acest punct: transmiterea unui singur fișier de analiză. Privit din noiembrie 2026, argumentul durabil este ca cerințele să însoțească notebookul, iar ceea ce rămâne în afara lui să fie precizat. Un fișier ușor de mutat și un experiment care poate fi repetat integral sunt livrabile diferite.
Ce a stabilit anunțul
Anunțul marimo din 16 septembrie 2024 descrie cerințe de pachete salvate într-un comentariu de la începutul fișierului Python al notebookului. Modul opțional de izolare folosește uv pentru a crea un mediu virtual și a instala dependențele declarate. Articolul descrie și urmărirea importurilor pentru a ajuta la întreținerea declarațiilor.
Specificația PEP 723 definește metadatele incluse în script, printre care dependențele și cerința privind versiunea Python. Data creării este 4 august 2023, iar rezoluția este datată 8 ianuarie 2024. Funcționalitatea notebookurilor din septembrie utiliza un standard existent; nu introducea standardul.
Mecanismul pune informațiile despre mediu lângă codul primit de destinatar. Izolarea ajută la separarea cerințelor declarate de pachetele instalate întâmplător pe calculatorul autorului. Este izolarea mediului de pachete, nu o garanție că orice cod din notebook poate fi executat fără risc sau că nu poate accesa fișiere și rețele.
Anexa lipsă ține și de proiectarea predării
Să presupunem că un analist trimite unui coleg un notebook pentru verificarea unei prognoze propuse. Dacă fișierul analizei ajunge fără fișierul separat cu cerințe, colegul trebuie să descopere ce lipsește. Chiar și un fișier corect de dependențe este inutil dacă modul obișnuit de transmitere îl lasă în urmă.
Includerea declarației schimbă predarea. Analiza și cerințele de pachete se află în același fișier, astfel că transmiterea analizei include și această parte a contractului de rulare. Este o îmbunătățire practică independentă de viteza instalării. Pentru articol nu s-au măsurat timpi de instalare și nu s-a făcut un studiu cu destinatari.
Contractul trebuie totuși examinat. Lista dependențelor directe poate fi incompletă, iar intervalele largi de versiuni pot permite rezolvări diferite în viitor. Fixarea versiunilor directe restrânge posibilitățile fără să fixeze neapărat fiecare dependență indirectă. Când contează refacerea exactă, stabiliți ce înregistrare suplimentară a rezolvării și ce politică de păstrare va folosi echipa. O declarație nu devine un inventar complet al versiunilor doar fiindcă include numere.
Datele au propriul istoric
Un notebook se poate instala corect și poate produce alt răspuns fiindcă datele de intrare s-au schimbat. O interogare curentă poate include acum încă o lună de tranzacții. Un fișier de la distanță poate fi înlocuit la aceeași adresă. Niciuna dintre situații nu se rezolvă prin includerea numelor de pachete.
Pentru o predare importantă, descrieți setul de date, limita temporală relevantă și versiunea sau copia fixată care a fost folosită. Precizați dacă destinatarul trebuie să refacă rezultatul anterior sau să reia analiza cu date actuale. Ambele sarcini sunt legitime, dar au criterii diferite de acceptare. Un total schimbat poate fi firesc în al doilea caz și un eșec în primul.
Separați permisiunile de descrieri. Notebookul trebuie să explice cum obține datele un destinatar autorizat, fără să includă secrete într-un fișier care poate fi trimis mai departe. Dacă accesul nu poate fi acordat, un set de date demonstrativ aprobat poate permite verificarea metodei, lăsând rezultatul inițial neverificat. Menționați explicit această limită.
Mediul virtual lasă alte dependențe în afară
Pachetele Python reprezintă doar o parte a mediului funcțional. Analiza poate depinde de o bibliotecă a sistemului de operare, de un program extern sau de adresa unui serviciu. Calculele influențate de echipament și intrările aleatorii pot produce alte variații. Declarația de pachete nu stabilește controlul asupra tuturor acestor factori.
Consemnați cerințele externe care afectează efectiv sarcina. Pentru o analiză locală simplă poate ajunge o notă scurtă. Pentru un rezultat reglementat sau păstrat mult timp, dovezile necesare pot fi mult mai ample și trebuie stabilite de organizația responsabilă. Articolul nu susține că un format de notebook îndeplinește asemenea obligații.
Este util un scop explicit, fără să fie neapărat maximal. Cine verifică logica grupării dintr-un grafic poate să nu aibă nevoie de imaginea exactă a calculatorului istoric. Cine cercetează de ce s-a schimbat cifra de anul trecut poate avea nevoie de date păstrate și de un mediu documentat mai strict. Stabiliți ce întrebare trebuie să rezolve predarea înainte să decideți efortul de conservare.
Mediul comun al proiectului poate fi alegerea mai bună
Cea mai puternică obiecție vine de la echipele care întrețin multe notebookuri cu biblioteci comune. Declarațiile separate pot ajunge să difere și pot ascunde faptul că analizele formează un singur proiect întreținut. Un mediu definit la nivelul depozitului de cod poate simplifica actualizarea și revizuirea coordonată.
Acesta este un motiv să alegeți deliberat unitatea pentru care vă asumați întreținerea. Dacă notebookurile circulă separat, declarațiile locale se pot potrivi transmiterii. Dacă depind de cod intern comun și sunt verificate mereu împreună, întregul proiect poate fi unitatea corectă de livrare. Un singur fișier nu trebuie prezentat ca livrare completă dacă are nevoie de restul depozitului.
Evitați aplicarea ambelor modele fără să stabiliți ce evidență are prioritate. O listă inclusă, dar învechită, și un mediu de proiect actual lasă destinatarului instrucțiuni contradictorii. Documentați modul acceptat de deschidere și rulare, apoi întrețineți acel traseu când se schimbă dependențele.
Folosiți sarcina destinatarului drept criteriu de acceptare
O predare utilă îi cere unui destinatar autorizat să deschidă fișierul în mediul curat prevăzut, să obțină datele specificate și să facă verificarea convenită. Notați cerințele lipsă și diferențele neexplicate. Acesta este un exercițiu propus de acceptare, nu un test efectuat aici asupra marimo.
Pentru un instrument software sau de analiză la comandă, definiți ce trebuie să poată repeta destinatarul și ce rămâne în afara livrării. Funcționalitatea marimo din septembrie a apropiat contractul de pachete de analiză. O predare responsabilă îi spune următoarei persoane și unde se încheie acel contract.