Presentasjon av oblig 2

Transkript

1 Presentasjon av oblig 2 Jonathan Feinberg 1,2 Joakim Sundnes 1,2 Center for Biomedical Computing, Simula Research Laboratory 1 Dept. of Informatics, University of Oslo 2 Sep 30, 2014

2 Obligatorisk oppgave 2, H14 Generelt om obliger og oblig 2 Innlevering, retting Samarbeid, kopiering Kort gjennomgang av oppgavene

3 Oblig 1, retting og omretting Retting stort sett fullført innen frist Frist for omretting: Fredag 3. oktober kl Opprett en issue på github når endringene er gjort, og oppgaven er klar for vurdering av gruppelærer Hvis du ikke oppretter en Issue blir oppgaven vurdert i helgen

4 Obliger i INF3331 Obligatoriske oppgaver er ment å være hovedtyngden av arbeidsmengden i INF3331 Høst 2014 blir det totalt tre obligatoriske oppgaver Oblig 2 blir den klart mest omfattende

5 Oblig 2, oversikt (1) Bygger på det meste som er gjennomgått til nå Tekstprosessering, lbehandling, regulære uttrykk, testing og dokumentasjon Fokus på Python, samt kjøring av Bash-prosesser fra Python

6 Oblig 2, oversikt (2) En preprosessor som gir tilleggsfunksjonalitet i L A T E X Nyttig for alle som skriver en større rapport om et programmeringsprosjekt (f.eks. masteroppgave) Generelt nyttig programmeringskunnskap (manipulering av tekst og kode, kodegenerering, domain specic languages, e-bøker,...) 13 deloppgaver totalt. 7 er obligatoriske, og man velger 3 av de resterende 6

7 Innlevering og retting Skjer i github, på samme måte som sist Kriterier for retting vil revideres noe Fokus på rapport, dokumentasjon, testing En innlevering kan inneholde all ønsket funksjonalitet, men hvis dette er umulig å se så blir den likevel underkjent

8 Oblig 2, arbeidsmengde Oblig 2 er langt mer omfattende enn oblig 1 Mange vil synes oppgavene er krevende Gruppelærere og forelesere tilbyr mye hjelp, men det forutsetter at dere kommer i gang tidlig Dagen før fristen er det for sent å komme med omfattende og fundamentale spørsmål til gruppelærer Utsettelse av innleveringsfristen krever erklæring fra lege

9 Samarbeid og kopiering (1) Samarbeid er lov, men dere må huske å dokumentere det i rapporten, og alle skal levere en selvstendig besvarelse og rapport Veldig like obliger, uten kommentar om samarbeid, vil antas å være kopiert Ved mistanke om kopiering vil vi kalle inn begge til en samtale: Kan man forklare hva som er gjort i obligen er alt ok. Hvis ikke antar vi at den er kopiert.

10 Samarbeid og kopiering (2) IFI ser på kopiering som fusk: IFI-adm til stede ved samtale om kopiert oblig Man risikerer utestengelse hvis det avdekkes mistanke om kopiering/fusk Dette er ikke noe vi ønsker, så vær nøye med å dokumentere samarbeid om obliger, og hva som er gjort i obligen.

11 Oblig 2, oppgave 1* Kodeimport: Erstatte "klipp og lim" med linjer på formen script_example.py ( *out =(. \n)*?return out) Finn linjer %@import i l Hent ut lnavn og regulært uttrykk Hent kode fra riktig l, utvid med riktige Verbatim-linjer etc. Lim inn i tex-l

12 Oblig 2, oppgave 2* Eksekvering av skript: Samme som over, men nå er det output fra et skript som skal limes inn python script_example.py 4 Samme som for oppgave 1 Kjøre skript og Bash-kommandoer fra Python

13 Oblig 2, oppgave 3 Kodeformatering: Penere og mer eksibel formatering av det som limes inn i oppgave 1 og 2 Bruk av mer avanserte L A T E X-pakker Mulighet for å velge formatering

14 Oblig 2, oppgave 4 Innliming av kode: Ved å utelate lnavn i linjene fra oppgave 1 og 2 skal preprosessoren tolke det som ordinær innliming av kode: %@import Dette er en viktig kode-snutt. %@ Mer eksibel prosessering av l, som kjenner igjen og spesialbehandler f.eks. %@import uten lnavn

15 Oblig 2, oppgave 5 Kodeeksekvering: Som oppgave 2, men koden som skal kjøres er nå en del av dokumentet Kjenne igjen %@python etc, og hente ut tilhørende kodelinjer Eksekvere Python og Bash kode fra Python.

16 Oblig 2, oppgave 6 Skjult tekst i dokumentet: Mulighet til å vise eller skjule tekst, basert på verdien til en variabel Denering av variable i tekst-l Gjenkjenning av %show etc og sjekk på variabelnavn

17 Oblig 2, oppgave 7* Kompilering av L A T E X-l: L A T E X gir generelt mye output, som gjemmer de viktige feilmeldingene Vi ønsker automatisk prosessering av output, som gjør det eektivt å nne feil i L A T E X-dokumenter Bruk av subprocess.popen (brukes også i oppgave 2) Tekstsøk i output

18 Oblig 2, oppgave 8* Inkludering av ler: L A T E X kan inkludere ler med kommandoen \input{path/to/file}. Vi ønsker at preprosessoren også skal håndtere dette Preprosessor må gjenkjenne \input-kommandoer. Underliggende ler må prosesseres på samme måte som over Preprosesserte ler limes inn i hovedl

19 Oblig 2, oppgave 9 Fil-tre: Vi ønsker å erstatte innliming fra oppgave 9, og beholde og preprosessere hver l separat Generering av mappe, mappetre Kopiering av preprosesserte ler til riktig mappe Endring av \input-linjer i hovedl, siden lene er yttet

20 Oblig 2, oppgave 10 Linjenummerering: Inkludering av ler gjør output og feilmeldinger fra L A T E X mye mer forvirrende. Riktig prosessering av output kan løse dette Samme som for oppgave 7 Mer avansert output, med linjenummer i opprinnelig l Midlertidig preprosessering, se hint i oppgavetekst

21 Oblig 2, oppgave 11* Front-end: Fornuftig kommandolinje-interface til preprosessor og postprosessor Bruk av argparse-modul

22 Oblig 2, oppgave 12* Testing og dokumentasjon: Doc-strings med doc-tester for all funksjonalitet Test-suite basert på nose eller pytest Rammeverk introdusert på forelesning 16/9 Noen av testene genererer ler, som må fjernes etter kjøring. Funksjonaliteten teardown i nose i tillegg til setup. (Lag tester underveis, eventuelt først, ikke som en ekstrajobb til slutt)

23 Oblig 2, oppgave 13* Rapporten: Standard rapport skrevet i L A T E X, etter samme mal som sist Tips: Rapporten bør bruke funksjonaliteten du har laget