Allaolevien tehtävien deadline on maanantai 10.11. klo 23:59

Apua tehtävien tekoon kurssin Discord-kanavalla sekä kampuksella pajassa BK107:

  • ma 14.30-16.30
  • ti 12-16
  • to 12-16
  • pe 12-14

Liittyminen kurssin Discord-kanavalle tapahtuu komennolla /join course TKT20006 - Ohjelmistotuotanto - ohtu

Muista myös tämän viikon monivalintatehtävät, joiden deadline on sunnuntai 9.11. klo 23:59:00 .

Viikon tehtävissä 1-4 tutustutaan riippuvuuksien hallintaan Poetryllä ja ohjelmoidaan hieman paria kirjastoa hyödyntäen. Tehtävissä 6-8 tutustutaan koodin staattiseen analyysin Pylint-työkalun avulla. Gitiin tutustuminen jatkuu tehtävissä 9-13.

Typoja tai epäselvyyksiä tehtävissä?

Tee korjausehdotus editoimalla tätä tiedostoa GitHubissa.

Kurssipalaute

Kurssilla on käytössä normaalin lopussa kerättävän palautteen lisäksi ns. jatkuva palaute: voit antaa milloin vain kurssihenkilökunnalle anonyymiä palautetta osoitteessa https://norppa.helsinki.fi/targets/95023982/feedback

Ongelmia Poetryn kanssa?

Muutamia ohjeita täällä

Tehtävien palauttaminen

Tehtävät palautetaan GitHubiin, sekä merkitsemällä tehdyt tehtävät palautussovellukseen https://study.cs.helsinki.fi/stats/courses/ohtu2025 välilehdelle “my submission”.

Tehtävät 6 ja 7 laajentavat viime viikon ensimmäistä tehtäväsarjaa, eli ne palautetaan ohtuvarasto-repositorioon, siis samaan mitä käytettiin viikon 1 tehtävissä 2-13. Muut tehtävät palautetaan palautusrepositorioon, eli samaan mihin palautit ensimmäisen viikon tehtävät 14-17.

Katso tarkempi ohje palautusrepositorioita koskien täältä.

GitHub Education

Muutama myöhemmin kurssilla oleva tehtävä käyttää GitHubin Copilotia, joka käyttö on ilmaista jos aktivoit GitHub Education -jäsenyyden. Jos et ole vielä jäsen, hae jäsenyyttä nyt. Hakemuksen hyväksyminen kestää internetin mukaan jopa viikon.

Checkboxit tehtävien teon seurannan apuna

Kurssin tehtävänannot ovat välillä pitkiä. Tekstin seasta saattaa olla haastavaa bongata niitä askelia, jotka edellyttävät toimenpiteitä. Tehtävien selkeyttämiseksi ja seurannan helpottamiseksi tehtävien toimenpiteitä edellyttävät askeleet on merkitty ranskalaisten viivojen sijaan checkboxeilla.

Voit käyttää checkboxeja oman edistymisesi seurannan helpottamiseen. Kun askel on tehty, rastita boksi. Näin et mene sekaisin sen suhteen, missä kohtaa olet menossa. Huomaa, että boksit eivät sisällä mitään toiminnallisuutta, ja rastit nollautuvat, jos lataat sivun uudelleen.

1. Poetryn harjoittelua

Tämä tehtävä tehdään palautusrepositorioon, siis samaan mihin tehtiin viikon 1 tehtävät 14-17

Tee palautusrepositorioon hakemisto viikko2 ja sen sisälle hakemisto poetry-web tätä tehtävää varten

Lue täältä lisää tehtävien palautusrepositorioista

Varoitus: pip

Olet saattanut asentaa Pythonin tarvitsemia riippuvuuksia pip-komennolla. Älä käytä pipiä tällä kurssilla sillä jos teet niin, teet 99.9% todennäköisyydellä jotain väärin.

Tällä kurssilla riippuvuudet asennetaan poetryllä.

Tämä tarkoittaa käytännössä sitä, että riippuvuudet asennetaan komennolla poetry add kirjasto komennon pip install kirjasto sijaan.

Tässä tehtävässä harjoittelemme lisää Poetryn käyttöä ja tutustumme semanttiseen versiointiin. Apua tehtävän tekoon saa mm. Ohjelmistotekniikka-kurssilta lainatusta Poetry-ohjeesta ja Poetryn dokumentaatiosta.

Kuvitellaan tilanne, jossa työskentelet ohjelmistokehittäjänä kehitystiimissä, joka on alkamassa kehittämään web-sovellusta. Olette päätyneet kehittämään sovelluksen Pythonilla ja käyttämään Poetrya riippuvuuksien hallinnassa.

Tee seuraavat toimenpiteet:

Alusta projekti Poetryn avulla poetry-web nimiseen hakemistoon tehtävien palautukseen käyttämäsi repositorion hakemiston viikko2 sisälle

Muista käyttää alustuksessa komentoa poetry init --python "^3.12", jotta projektin Python-version vaatimus asetetaan oikein.

Etsit Googlettamalla sopivia kirjastoja web-sovellusta varten ja törmäät Flask-viitekehykseen.

Asenna Flask projektin riippuvuudeksi Poetryn avulla

Sovelluksessa ilmenee ensimmäinen bugi. Syynä on luultavasti se, ettei sovellukselle ole toteutettu vielä yhtään testiä. Päädyt käyttämään testauksessa pytest-kirjastoa.

Asenna pytest projektin kehitysaikaiseksi riippuvuudeksi

  • Pohdi itseksesi, miksi on hyödyllistä määritellä riippuvuus erikseen kehityksen aikaiseksi riippuvuudeksi

Sovellus käyttää relaatiotietokantaa joten päädyt etsimään tarkoitukseen sopivia kirjastoja. Törmäät tarkoitukseen sopivaan kirjastoon nimeltä SQLAlchemy.

Asenna SQLAlchemy projektin riippuvuudeksi

Huomaat bugin SQLAlchemy-kirjastossa, joten alat tutkimaan sen GitHub repositorion issueita. Eräässä issuessa kerrotaan, että löytämäsi bugi ei ilmene kirjaston versiossa 1.4.54.

Asenna SQLAlchemy-kirjastosta versio 1.4.54

Tutustu semanttiseen versiointiin täällä

  • Pohdi, mitä hyötyjä semanttisesta versioinnista on. Jos kirjasto noudattaa semanttista versiointia, miksi kirjaston version 1.4.54 päivittäminen versioon 2.0.44 saattaa sisältää riskejä? Miksei samoja riskejä luultavasti ole versiosta 2.0.5 versioon 2.0.44?
  • Versiovaatimuksissa on mukana usein ^- tai ~-etuliite. Selvitä, mitä näillä ilmaistaan. Asiaa käsitellään mm. Poetryn dokumentaatiossa

Kuulet kaveriltasi, että Flaskin sijaan kannattaisi käyttää FastAPI-kirjastoa.

Poista Flask projektin riippuvuuksista ja asenna FastAPI.

Palautettavasta poetry-web-hakemistosta ei tarvitse löytyä muita tiedostoja kuin pyproject.toml ja poetry.lock.

2. Riippuvuuksien hyödyntäminen: Pelaajalista

Hae kurssirepositorion hakemistossa viikko2/nhl-reader lähes tyhjä Poetry-projektin runko. Mukana on kohta tarvitsemasi luokka Player.

Kopioi projekti palautusrepositorioosi, hakemiston viikko2 sisälle.

Tehdään ohjelma, jonka avulla voi hakea jääkiekon NHL-liigan eri kausien tilastotietoja.

Näet tilastojen JSON-muotoisen raakadatan web-selaimella osoitteesta https://studies.cs.helsinki.fi/nhlstats/2024-25/players

Tee ohjelma, joka listaa suomalaisten pelaajien tilastot.

Tarvitset ohjelmassa yhtä kirjastoa, eli riippuvuutta. Kyseinen kirjasto on requests-kirjasto, jonka avulla voi tehdä HTTP-pyyntöjä. Huomaa, että Pythonilla on myös valmiita moduuleja tähän tarkoitukseen, mutta requests-kirjaston käyttö on huomattavasti näitä moduuleja helpompaa.

Asenna siis requests-kirjasto projektin riippuvuudeksi. Käytä kirjastosta uusinta versiota (jonka Poetry asentaa automaattisesti).

Voit ottaa projektisi pohjaksi seuraavan tiedoston:

import requests
from player import Player

def main():
    url = "https://studies.cs.helsinki.fi/nhlstats/2024-25/players"
    response = requests.get(url).json()

    print("JSON-muotoinen vastaus:")
    print(response)

    players = []

    for player_dict in response:
        player = Player(player_dict)
        players.append(player)

    print("Oliot:")

    for player in players:
        print(player)

Tehtäväpohjassa on valmiina luokan Player koodin runko. Edellä esitetyssä koodissa requests.get(url) tekee HTTP-pyynnön, jonka jälkeen json-metodin kutsu muuttaa JSON-muotoisen vastauksen Python-tietorakenteiksi. Tässä tilanteessa response sisältää listan dictionaryja. Tästä listasta muodostetaan lista Player-olioita for-silmukan avulla.

Tässä tehtävässä on tarkoituksena toteuttaa toiminnallisuus, jonka avulla on mahdollista tulostaa tietyn kansalaisuuden pelaajat, esim. suomalaiset.

Tee Player-luokkaan attribuutit kaikille JSON-datassa oleville kentille, joita ohjelmasi tarvitsee.

Ohjelmasi voi toimia esimerkiksi niin, että se tulostaisi pelaajat seuraavalla tavalla:

Players from FIN:

Juuso Välimäki team UTA  goals 2 assists 3
Anton Lundell team FLA  goals 17 assists 28
Ville Ottavainen team SEA  goals 0 assists 1
Roope Hintz team DAL  goals 28 assists 39
Rasmus Ristolainen team PHI  goals 4 assists 15
Ville Koivunen team PIT  goals 0 assists 7
Mikael Pyyhtia team CBJ  goals 4 assists 3
Mikko Rantanen team COL, CAR, DAL  goals 32 assists 56
...

Tulostusasu ei tässä tehtävässä ole oleellinen, eikä edes se, mitä pelaajien tiedoista tulostetaan.

3. Siistimpi pelaajalista

Tulosta suomalaiset pelaajat pisteiden (goals + assists) mukaan järjestettynä.

Tarkka tulostusasu ei taaskaan ole oleellinen, mutta se voi esimerkiksi näyttää seuraavalta:

Players from FIN

Mikko Rantanen        COL, CAR, DAL   32 + 56 = 88
Sebastian Aho         CAR             29 + 45 = 74
Aleksander Barkov     FLA             20 + 51 = 71
Roope Hintz           DAL             28 + 39 = 67
Mikael Granlund       SJS, DAL        22 + 44 = 66
Teuvo Teravainen      CHI             15 + 43 = 58
Anton Lundell         FLA             17 + 28 = 45
Artturi Lehkonen      COL             27 + 18 = 45
Kaapo Kakko           NYR, SEA        14 + 30 = 44
Eeli Tolvanen         SEA             23 + 12 = 35
...
  • Vihje 1: Täällä on kerrottu miten järjestäminen Pythonilla tapahtuu
  • Vihje 2: voit halutessasi hyödyntää filter-funktiota.
  • Vihje 3: kokeile, mitä f"{self.name:20}" tekee merkkijonoesitykselle Player-luokan __str__-metodissa.
  • Erityisesti vihje 2 on heikko, katso miten saat apua tekoälyltä
  • Myös Ohjelmoinnin MOOCin osa 11 ja osa 12 käsittelevät tehtävän kannalta hyödyllisiä asioita

4. Pelaajalistan refaktorointi

Tällä hetkellä suurin osa pelaajatietoihin liittyvästä koodista on luultavasti main-funktiossa. Funktion koheesion aste on melko matala, koska se keskittyy usean toiminnallisuuden toteuttamiseen. Koodi kaipaisi siis pientä refaktorointia.

Jaa toiminnallisuuden vastuut kahdelle luokalle: PlayerReader ja PlayerStats.

  • PlayerReader-luokan vastuulla on hakea JSON-muotoiset pelaajat konstruktorin parametrin kautta annetusta osoitteesta ja muodostaa niistä Player-olioita. Tämä voi tapahtua esimerkiksi luokan get_players-metodissa.
  • PlayerStats-luokan vastuulla on muodostaa PlayerReader-luokan tarjoamien pelaajien perusteella erilaisia tilastoja. Tässä tehtävässä riittää, että luokalla on metodi top_scorers_by_nationality, joka palauttaa parametrina annetun kansalaisuuden pelaajat pisteiden mukaan laskevassa järjestyksessä (suurin pistemäärä ensin).

Refaktoroinnin jälkeen main-funktion tulee näyttää suurin piirtein seuraavalta:

def main():
    url = "https://studies.cs.helsinki.fi/nhlstats/2024-25/players"
    reader = PlayerReader(url)
    stats = PlayerStats(reader)
    players = stats.top_scorers_by_nationality("FIN")

    for player in players:
        print(player)

Funktion pitäisi tulostaa samat pelaajat samassa järjestyksessä kuin edellisessä tehtävässä.

5. Graafinen pelaajalista

Laajenna sovellustasi lisäämällä siihen toiminnallisuutta ja muotoilemalla tulostus kirjaston Rich avulla.

Ohjeita kirjaston käyttöön löytyy sen dokumentaatiosta ja googlaamalla tai tekoälyltä.

Sovelluksen tulee pystyä näyttämään käyttäjän haluaman maan pelaajien tilastot käyttäjän määrittelemältä kaudelta.

Sovelluksen toiminta voi näyttää esimerkiksi seuraavalta:

Tämä tehtävä tehdään palautusrepositorioon, siis samaan mihin teit edellisen tehtävän

6. Pylint ja koodin staattinen analyysi

Tämä ja seuraava tehtävä tehdään viime viikon tehtävissä 2-13 käytettyyn ohtuvarasto-repositorioon

Kurssin kolmannessa osassa teemana on ohjelmien laadun varmistaminen. Eräs ohjelman laatua useimmiten edistävä tekijä on järkevän koodityylin noudattaminen. Koodin tyyliä voidaan tarkkailla automatisoidusti niin sanottujen staattisen analyysin työkaluilla.

Tutustutaan nyt staattisen analyysin työkaluun nimeltään Pylint. Pylint on jo ehkä tullut tutuksi kurssilta Ohjelmistotekniikka.

Aloita lukemalla kurssilta Ohjelmistotekniikka lainattu Pylint-ohje.

Mene nyt viikon 1 varasto-projektiin liittyvien tehtävien palautusrepositorioosi.

Ota varasto-projektissa käyttöön Pylint noudattamalla lukemiasi ohjeita.

Konfiguraationa käytettävän .pylintrc-tiedoston sisältö on toistaiseksi tämän tiedoston sisällön mukainen.

Pylintin tarkistamat säännöt konfiguroidaan .pylintrc-tiedostoon oikeiden osioiden alle. [main]-osio sisältää yleisiä konfiguraatioita, kuten mitkä hakemistot tai tiedostot pitäisi jättää tarkistuksien ulkopuolelle. [MESSAGE CONTROL]-osiossa taas voidaan määritellä esimerkiksi tarkistuksia, joista ei tarvitse huomauttaa. Loput osiot ovat eri sääntöjen konfigurointia varten, jotka on dokumentoitu Pylintin dokumentaatiossa.

Jos haluamme esimerkiksi asettaa funktioiden ja metodien argumenttien maksimilukumäärä neljään, voimme lisätä sen [DESIGN]-osioon seuraavasti:

[DESIGN]

max-args=4

Sääntö max-args on määritelty dokumentaatiossa seuraavasti:

Säännön nimen alussa olevaa kahta viivaa ei siis tule kirjoittaa tiedostoon .pylintrc

Helpoin tapa löytää sääntöjä on hakemalla sopivalla hakusanalla niitä dokumentaatiosta, Googlettamalla tai kysymällä tekoälyltä. Oikean osion löytää dokumentaatiosta (esimerkiksi max-args-sääntö löytyy dokumentaatiosta Design checker -osion alta).

Toimi nyt seuraavasti:

Siirry virtuaaliympäristöön komennolla eval $(poetry env activate) ja suorita sen sisällä komento pylint src. Jos tarkistuksissa löytyy virheitä, korjaa ne

Määrittele nyt tiedostoon .pylintrc seuraavat säännöt (katso lista säännöistä Pylintin dokumentaatiosta):

  • Rivin pituus on maksimissaan 80 merkkiä
    • Vinkki: sääntö löytyy Format checker -osiosta ja tulee määrittää [FORMAT]-osion alle
  • Yksi sisennystason leveys on 4 merkkiä
  • Ei yli kahta sisäkkäistä lohkoa (esimerkiksi if- tai for-lohkoa) funktion tai metodin sisällä
    • Vinkki: sääntö löytyy Refactoring checker -osiosta ja tulee määrittää [REFACTORING]-osion alle)
  • Funktiossa tai metodissa on enintään 10 lausetta (statements). Etsi sääntö dokumentaatiosta
    • voit lyhentää index.py:ssä olevaa funktiota main siten, että se täyttää ehdon
  • Määrittele myös jokin itse valitsemasi, mielenkiintoiselta/hyödylliseltä kuulostava sääntö

Muuta koodiasi siten, että saat jokaisen määritellyistä Pylint-säännöistä rikkoutumaan

Korjaa koodisi ja varmista, että se noudattaa kaikkia sääntöjä

Usein .pylintrc-konfiguraatiota ei ole järkevää kirjoittaa tyhjästä käsin, vaan käytetään lähtökohtana Pylintin suosittelemaa konfiguraatiota. Suositellun konfiguraation voi tulostaa komentoriville komennolla pylint --generate-rcfile.

7. Koodin staattinen analyysi ja GitHub Actionit

Tämä tehtävä tehdään viime viikon tehtävissä 2-13 käytettyyn ohtuvarasto-repositorioon

Laajenna ohtuvarastosi GitHub Actions -määritelmää siten, että myös Pylint-tarkastukset suoritetaan aina kun koodi pushataan GitHubiin

Varmista, että GitHub huomaa tilanteen, missä koodi rikkoo projektin Pylint-sääntöjä:

Varmista myös, että kun korjaat koodin, kaikki toimii taas moitteettomasti:

8. Precommit hook ja Pylint

GitHub Action siis varmistaa, että repositorioon päätyneet Pylint-virheet huomataan. Parempi olisi toki, että sovelluskehittäjä suorittaisi Pylintin aina omalla koneellaan ja korjaisi virheet ennen kuin niitä pääsee livahtamaan GitHubin puolelle. Sovelluskehittäjät ovat kuitenkin usein laiskoja ja huonomuistisia, näinpä Pylint herkästi jää suorittamatta paikallisesti. Git tarjoaa kätevän ominaisuuden hookit, jonka avulla voimme automatisoida erilaisia esim. ennen committia suoritettavia toimenpiteitä.

Python-projekteissa hookien konfigurointi on helppoa precommit-työkalun avulla.

Asenna pre-commit ohtuvarastoon seuraavalla komennolla

poetry add pre-commit --group dev

Lisää projektin juureen tiedosto .pre-commit-config.yaml ja sille seuraava sisältö

repos:
- repo: local
  hooks:
    - id: pylint
      name: pylint
      entry: pylint
      language: system
      types: [python]
      require_serial: true

Määrittelyn jälkeen precommit hook tulee vielä asentaa suorittamalla seuraava komento projektin virtuaaliympäristössä

pre-commit install

Huomaa, että komento on suoritettava aina, kun tiedostoa .pre-commit-config.yaml muutetaan!

Kun nyt suoritat komennon git commit -m"viesti" suoritetaan Pylint ennen committia, ja jos koodissa on virheitä, ei commit onnistu.

Tee koodiin Pylint-virhe, ja varmista, että precommit hook havaitsee virheen.

Lisää Pylint myös tehtävien 2-5 projektiin nhl-reader, ja korjaa mahdolliset virheet. Käytä samanlaista konfiguraatiota, jonka teit tehtävässä 6. Voit lisätä rivin maksimipituutta, 80 on modernina aikana turhan vähän.

Bonus: palautusrepositorio ja precommit hook

Konfiguroi palautusrepositioriosi siten, että se suorittaa Pylintin precommit hookissa tehtävien 2-5 projektille nhl-reader. Tämä tehtävä on hieman haasteellisempi, sillä Poetry-ympäristöä ei ole määritelty repositorion juuressa.

precommit-työkalun sijaan tässä tehtävässä saattaa olla helpompaa tehdä precommit hook “käsin” projektin juuressa olevaan tiedostoon .git/hooks/precommit.

Apuna kannattaa käyttää kaikkea mahdollista aina googlesta tekoälyyn.

9. Git: branchit [versionhallinta]

Tämä tehtävä tehdään palautusrepositorioon, siis samaan mihin tehtiin tehtävät 1 ja 2

Lue brancheja käsittelevät osuudet seuraavasta https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging

Kannattaa huomioida myös melko hyvä brancheja käsittelevä visuaalinen materiaali osoitteessa https://learngitbranching.js.org/

Varsin selkeältä vaikuttaa myös https://www.atlassian.com/git/tutorials/using-branches

Gitinkin suhteen kielimallit ovat myös varsin osaavia, eli hätätapauksessa voit turvautua vaikkapa CurreChatiin.

Huom: kun liikut branchien välillä kannattaa pitää working tree ja staging-alue tyhjinä!

Tee palautusrepositorion viikon 2 tehtävien hakemistoon alihakemisto git-branch-harjoitus tämän ja muutaman seuraavan tehtävän koodia varten.

Mene luomaasi hakemistoon

Varmista että olet haarassa main, ja että kaikki muutokset on committoitu:

$ git status
On branch main
nothing to commit, working tree clean

Luo ja committaa hakemistoon tiedosto index.py jonka sisältö on seuraava

x = int(input("luku 1: "))
y = int(input("luku 2: "))

Luo branch laskut, siirry branchiin (tämä tapahtuu esim. komennolla git checkout -b laskut), luo sinne tiedosto summa.py jolla on seuraava sisältö

def summa(x, y):
    return x+y

lisää ja committaa tiedosto versionhallintaan

Siirry takaisin main-branchiin (komennollagit checkout main), tiedoston summa.py ei pitäisi nyt näkyä

  • huom: muistutus vielä siitä, että kun siirryt branchista toiseen varmista aina komennolla git status että kaikki muutokset on committoitu

Luo tiedosto logger.py, jolla on seuraava sisältö

from datetime import datetime

def logger(viesti):
  print(f"{datetime.now()}: {viesti}")

Muuta myös tiedostoa index.py seuraavasti:

from logger import logger

logger("aloitetaan")

x = int(input("luku 1: "))
y = int(input("luku 2: "))

logger("lopetetaan")

Commitoi nämä muutokset main-haaraan

Mene branchiin laskut ja tarkasta, että mainiin lisätty tiedosto ei ole branchissa ja että tiedostoon index.py tehty muutos ei näy

Lisää ja committaa branchiin tiedosto erotus.py jolla on seuraava sisältö

def erotus(x, y):
    return x-y

Siirry takaisin main-branchiin

Tarkasta että laskut-branchiin lisätyt muutokset eivät ole mainissa

Tarkastele komennolla gitk --all miltä repositorio ja branchit näyttävät (gitk-komento toimii Windowsilla ainakin GitHub for Windowsin Git Shellissä.)

Mergaa branchin laskut sisältö mainiin (tämä tapahtuu komennollagit merge laskut)

  • Mergaaminen aiheuttaa ns. merge-commitin, ja avaa tekstieditorin, johon joudut kirjoittamaan commit-viestin
    • Jos et ole määritellyt gitille editoria viime viikon tehtävän 2 ohjeiden mukaan, avautuu ehkä gitin oletusarvoinen editori vim
    • Vimistä poistuminen saattaa osoittautua ensikertalaiselle hankalaksi, Google auttaa tarvittaessa

Muuta tiedostoa index.py seuraavasti ja commitoi muutos:

from logger import logger
from summa import summa
from erotus import erotus

logger("aloitetaan")

x = int(input("luku 1: "))
y = int(input("luku 2: "))
print(f"{summa(x, y)}")
print(f"{erotus(x, y)}")

logger("lopetetaan")

Katso jälleen miltä näyttää gitk --all-komennolla

10. Git: branchit ja staging-alue [versionhallinta]

Varmista, että olet repositoriosi main-haarassa

Luo uusi tiedosto README.md, älä kuitenkaan lisää ja commitoi tiedostoa versionhallintaan

Tiedoston sisällöllä ei ole merkitystä, se voi olla esim. seuraava

## git-harjoituksia

Harjoitellaan branchien käyttöä

Tee komento git status ja varmista, että tulos on

On branch main
Untracked files:
  (use "git add <file>..." to include in what will be committed)

	README.md

nothing added to commit but untracked files present (use "git add" to track)

Siirry nyt branchiin laskut

Suorita uudelleen komento git status

  • Huomaat, että tulostus on edelleen sama, tiedosto README.md ei edelleenkään ole versionhallinnan alla
  • Eli vaikka olit main-haarassa kun loit tiedoston, ei main-haara eikä koko git tiedä tiedostosta vielä mitään ennen kuin lisäät sen versionhallinnan alaisuuteen komennolla git add

Lisää tiedosto nyt versionhallinnan alaisuuteen ja commitoi se

  • Tiedosto menee nykyiseen branchiisi, eli branchiin laskut, main ei edelleenkään tiedä tiedostosta mitään

Olet edelleen branchissa laskut. Luo uusi tiedosto LICENSE ja lisää se versionhallintaan (komennolla add), älä kuitenkaan commitoi

Tiedoston sisällöllä ei ole merkitystä, se voi olla esim. seuraava

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

For more information, please refer to <https://unlicense.org>

Tarkasta että komennon git status tulos on seuraava:

On branch laskut
Changes to be committed:
   (use "git restore --staged <file>..." to unstage)

	new file:   LICENSE
  • Olet siis branchissa laskut ja LICENSE on lisätty staging-alueelle, sitä ei kuitenkaan ole vielä committoitu

Siirry nyt branchiin main ja suorita git status

  • Komennon tulos on edelleen sama, LICENSE on edelleen staging-alueella mutta committoimattomana
  • Staging-alue ei kuulu mihinkään branchiin, eli jos staging-alueella on committoimattomia muutoksia ja vaihdat branchia, säilyvät samat asiat stagingissa
  • Muutokset siirtyvät stagingista branchiin ainoastaan komennolla git commit

Committoi nyt staging-alueen muutokset eli LICENSE haaraan main

Varmista, komennolla git status että staging-alue on tyhjä:

On branch main
nothing to commit, working tree clean

Siirry jälleen branchiin laskut ja huomaat, että LICENSE ei ole olemassa

Mergaa main-branch branchiin laskut

Siirry nyt takaisin branchiin main ja tuhoa branch laskut

  • Tuhoaminen ei onnistu suoraan komennolla git branch -d, jos branchin sisältö ei ole kokonaisuudessaan mergetty mainiin.
  • Jos näin on, tee ensin merge mainiin, tai jos tarkoituksena on poistaa branch silti vaikka siinä on vielä eriäviä muutoksia, käytä git branch -D poistaaksesi branch eriävine muutoksineen

Tämän tehtävän ideana oli siis havainnollistaa, että working tree (muutokset joista Git ei ole tietoinen) ja staging (gitiin lisättyihin tiedostoihin tehdyt committoimattomat muutokset) eivät liity mihinkään branchiin, muutokset siirtyvät staging-alueelta branchiin ainoastaan komennon git commit suorituksen seurauksena.

11. Git: konflikti! [versionhallinta]

Jatketaan edellisen tehtävän repositorion parissa

Muuta main-branchin tiedostoa index.py seuraavasti:

# tehdään alussa importit

from logger import logger
from summa import summa
from erotus import erotus

logger("aloitetaan")

x = int(input("luku 1: "))
y = int(input("luku 2: "))
print(f"{summa(x, y)}")
print(f"{erotus(x, y)}")

logger("lopetetaan")

Alkuun on siis lisätty kommentti ja tyhjä rivi

committaa muutos

Tee uusi branch bugikorjaus, mene branchiin ja editoi tiedoston index.py loppua (esim. seuraavasti) ja committaa

# tehdään alussa importit

from logger import logger
from summa import summa
from erotus import erotus

logger("aloitetaan")

x = int(input("luku 1: "))
y = int(input("luku 2: "))
print(f"{summa(x, y)}")
print(f"{erotus(x, y)}")

logger("lopetetaan ohjelma")
print("goodbye!") # lisäys bugikorjaus-branchissa

Mene takaisin main-branchiin, editoi tiedoston index.py alkupuolta esim. seuraavasti (muutos on funktion logger parametrissa) ja committaa muutokset:

# tehdään alussa importit

from logger import logger
from summa import summa
from erotus import erotus

logger("aloitetaan ohjelma") # muutos mainissa

x = int(input("luku 1: "))
y = int(input("luku 2: "))
print(f"{summa(x, y)}")
print(f"{erotus(x, y)}")

logger("lopetetaan ohjelma")

Mergaa branchin bugikorjaus sisältö mainiin

  • Katso tiedoston index.py-sisältöä, sen pitäisi sisältää nyt molemmissa brancheissa tehdyt muutokset
  • Git osaa siis mergetä
  • Huom: jo tässä vaiheessa saattaa syntyä konflikti, jos olet vahingossa muuttanut merkkejä väärästä kohtaa tiedostoa! Toimi tällöin ao. ohjeen mukaan.

Olet edelleen branchissa main. Muuta tiedostoa print-komentojen osalta seuraavasti, ja committaa muutos

# tehdään alussa importit

from logger import logger
from summa import summa
from erotus import erotus

logger("aloitetaan ohjelma")

x = int(input("luku 1: "))
y = int(input("luku 2: "))
print(f"{x} + {y} = {summa(x, y)}") # muutos mainissa
print(f"{x} - {y} = {erotus(x, y)}") # muutos mainissa

logger("lopetetaan ohjelma")
print("goodbye!")

Siirry branchiin bugikorjaus ja muuta tiedostoa (jälleen print-komentojen osalta) seuraavasti ja committaa

# tehdään alussa importit

from logger import logger
from summa import summa
from erotus import erotus

logger("aloitetaan ohjelma")

x = int(input("luku 1: "))
y = int(input("luku 2: "))
print(f"Lukujen {x} ja {y} summa on {summa(x, y)}")  # muutos bugikorjaus-branchissa
print(f"Lukujen {x} ja {y} erotus on {erotus(x, y)}")  # muutos bugikorjaus-branchissa

logger("lopetetaan ohjelma")
print("goodbye!")

Mergaa branchin main sisältö branchiin bugikorjaus

  • Nyt pitäisi syntyä konflikti, komento aiheuttaa tulostuksen
Auto-merging index.py
CONFLICT (content): Merge conflict in index.py
Automatic merge failed; fix conflicts and then commit the result.
  • Git ei siis osannut yhdistää tiedostoon tehtyjä muutoksia, koska ne kohdistuvat samoille riveille, seurauksena on konflikti.

Ratkaise konflikti:

  • Editoi tiedoston index.py sisältö haluamaksesi
  • Ja toimi edellä mainitun artikkelien ohjeen mukaan, eli lisää konfliktoinut tiedosto staging-alueelle ja committoi

Jotkut editorit, esim Visual Studio Code sisältävät sisäänrakennetusti niin sanotun merge toolin, joka osaa jossain määrin helpottaa konfliktien ratkaisua:

12. Git: branchit ja GitHub [versionhallinta]

Aloita lukemalla ProGit-kirjasta luku Remote Branches.

Palaa branchiin main ja pushaa se GitHubiin. Jos päädyt seuraavaan virheilmoitukseen, toimi se ohjeen mukaan ja pushaa uudelleen:

fatal: The current branch main has no upstream branch.
To push the current branch and set the remote as upstream, use

    git push --set-upstream origin main

To have this happen automatically for branches without a tracking
upstream, see 'push.autoSetupRemote' in 'git help config'.

Mene branchiin bugikorjaus ja pushaa se GitHubiin

  • Komennon antama palaute kertoo jälleen miten saat komennon toimimaan

Varmista, että näet GitHubissa molemmat brachit

Kloonaa GitHub-repositoriosta koneellesi toinen klooni:

Katso komennolla git branch mitä brancheja paikallisesti on näkyvissä

  • Oletusarvoisesti mukana tulee kloonatessa ainoastaan main

Tee klooniin branch joka “träkkää” GitHubissa olevan projektisi branchia bugikorjaus (ks. https://git-scm.com/book/en/v2/Git-Branching-Remote-Branches kohta Tracking Branches)

Lisää “träkkäävään” branchiin tiedosto changelog.txt, committaa ja pushaa branch GitHubiin

Tarkastele GitHub-repositoriota selaimella, varmista että branch päivittyy

Tee klooniin uusi branch tulo ja sinne kahden luvun tulon laskeva funktio tiedostoon tulo.py

Muuta ohjelmaa seuraavasti

from logger import logger
from summa import summa
from erotus import erotus
from tulo import tulo

logger("aloitetaan ohjelma")

x = int(input("luku 1: "))
y = int(input("luku 2: "))
print(f"{x} + {y} = {summa(x, y)}") 
print(f"{x} - {y} = {erotus(x, y)}") 
print(f"{x} * {y} = {tulo(x, y)}") 

logger("lopetetaan")
print("goodbye!")

Commitoi ja pushaa kloonin branchin tulo muutokset GitHubiin ja varmista, että ne näkyvät siellä

  • Pushatessa saatat saada virheilmoituksen, ilmoitus kertoo mitä tulee tehdä

Mene GitHub-repositorion alkuperäiseen paikalliseen kopioon:

  • Äsken luotu branch ei ole vielä alkuperäisessä kopiossa

Tee alkuperäiseen kopioon branchia tulo träkkäävä branch

  • Huom: Joudut tekemään ensin komennon git fetch, jotta paikallinen kopio pääsee jyvälle siitä että GitHubiin on lisätty tavaraa

Mergaa haara tulo haaraan main ja tuhoa haara tulo sekä paikallisesti että GitHubista

Tee nyt uusi haara, nimeltään osamaara, lisää branchiin tiedosto osamaara.py ja pushaa se GitHubiin

Mene jälleen hetki sitten luotuun repositorion klooniin ja haaraan main

Anna komento git remote show origin. Komennon tulostuksen pitäisi näyttää seuraavalta:

* remote origin
  Fetch URL: git@github.com:mluukkai/ohtu-palautukset.git
  Push  URL: git@github.com:mluukkai/ohtu-palautukset.git
  HEAD branch: main
  Remote branches:
    bugikorjaus              tracked
    main                     tracked
    osamaara                 new (next fetch will store in remotes/origin)
    refs/remotes/origin/tulo stale (use 'git remote prune' to remove)
  Local branches configured for 'git pull':
    bugikorjaus merges with remote bugikorjaus
    main        merges with remote main
    tulo        merges with remote tulo
  Local refs configured for 'git push':
    bugikorjaus pushes to bugikorjaus (up to date)
    main        pushes to main        (up to date)
  • Komento kertoo, että Remote (eli GitHub) ja Local (eli paikallinen klooni) eivät ole branchien suhteen samassa tilassa.
  • Jo tuhottu branch tulo löytyy vielä paikallisesti, kun taas uutta branchia osamaara ei paikallisesti vielä ole.

Korjaa tilanne siten, että git remote show origin tulostaa

* remote origin
  Fetch URL: git@github.com:mluukkai/ohtu-palautukset.git
  Push  URL: git@github.com:mluukkai/ohtu-palautukset.git
  HEAD branch: main
  Remote branches:
    bugikorjaus tracked
    main        tracked
    osamaara    tracked
  Local branches configured for 'git pull':
    bugikorjaus merges with remote bugikorjaus
    main        merges with remote main
    osamaara    merges with remote osamaara
  Local refs configured for 'git push':
    bugikorjaus pushes to bugikorjaus (up to date)
    main        pushes to main        (up to date)
    osamaara    pushes to osamaara    (up to date)

Branchien kanssa työskentely voi aluksi tuntua sekavalta, varsinkin jos GitHubissa on myös useita brancheja.

Mihin brancheja käytetään?

Ohjelmistokehitystiimi voi soveltaa Gitin branchaystä hyvin monella eri tyylillä. Artikkeli https://www.atlassian.com/git/tutorials/comparing-workflows esittelee tähän muutamia vaihtoehtoja. Eräs yleinen tapa branchien käyttöön ovat ns. feature-branchit:

The core idea behind the Feature Branch Workflow is that all feature development should take place in a dedicated branch instead of the main branch. This encapsulation makes it easy for multiple developers to work on a particular feature without disturbing the main codebase. It also means the main branch will never contain broken code, which is a huge advantage for continuous integration environments.

Jos kiinnostaa, lue lisää yllä olevasta dokumentista.

13. Git: epäajantasaisen kloonin pushaaminen [versionhallinta]

Demonstroidaan vielä (viime viikon tehtävässä 11 mainittu) usein esiintyvä tilanne, jossa epäajantasaisen repositorion pushaaminen GitHubissa olevaan etärepositorioon epäonnistuu.

Mene alkuperäisen repositorion paikallisen kloonin main-haaraan, tee jokin muutos, commitoi ja pushaa se GitHubiin

Mene toisen kloonin main-haaraan ja tee sinne jokin muutos

Commitoi ja pushaa muutos GitHubiin

  • Kaikki ei kuitenkaan mene hyvin, seurauksena on seuraavantyylinen virheilmoitus:
$ git push
 ! [rejected]        main -> main (fetch first)
error: failed to push some refs to 'git@github.com:mluukkai/ohtu-palautukset.git'
hint: Updates were rejected because the remote contains work that you do
hint: not have locally. This is usually caused by another repository pushing
hint: to the same ref. You may want to first integrate the remote changes
hint: (e.g., 'git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

Virheen syynä on se, että GitHubissa oleva main-haara oli edellä paikallisen repositorion main-haaraa.

Ongelma ratkeaa seuraavasti. Tee ensin komento git pull. Saat gitiltä pitkän valitusviestin:

hint: You have divergent branches and need to specify how to reconcile them.
hint: You can do so by running one of the following commands sometime before
hint: your next pull:
hint:
hint:   git config pull.rebase false  # merge
hint:   git config pull.rebase true   # rebase
hint:   git config pull.ff only       # fast-forward only
hint:
hint: You can replace "git config" with "git config --global" to set a default
hint: preference for all repositories. You can also pass --rebase, --no-rebase,
hint: or --ff-only on the command line to override the configured default per
hint: invocation.
fatal: Need to specify how to reconcile divergent branches.

Käytännössä Git haluaa tietää minkälaisella strategialla paikallisen ja etärepositoriosi koodi tulisi yhdistää. Vaihtoehdoista kannattanee valita keskimmäinen, eli anna komentorivillä komento

git config pull.rebase true

Käytännössä valittu vaihtoehto tarkoittaa sitä, että Git suorittaa uudet lokaalit commitit etärepositoriossa olevien committien perään.

Voit nyt pullata koodin uudelleen komennolla git pull. Komento git push onnistuu nyt. Jatkossa vastaavista tilanteista selviää komennoilla git pull ja git push.

Toimi yllä kuvatulla tavalla ja varmista, että tekemäsi muutokset menevät GitHubiin

Tehtävien palautus

Pushaa kaikki tekemäsi tehtävät (paitsi ne, joissa mainitaan, että tehtävää ei palauteta mihinkään) GitHubiin palautusrepositorioosi ja merkkaa tekemäsi tehtävät palautussovellukseen https://study.cs.helsinki.fi/stats/courses/ohtu2025