/
Vimgolf4618714<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc 15.0.4"/>
<title>vimgolf_gym.lib API documentation</title>
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
<style>/*! syntax-highlighting.css */pre{line-height:125%;}span.linenos{color:inherit; background-color:transparent; padding-left:5px; padding-right:20px;}.pdoc-code .hll{background-color:#ffffcc}.pdoc-code{background:#f8f8f8;}.pdoc-code .c{color:#3D7B7B; font-style:italic}.pdoc-code .err{border:1px solid #FF0000}.pdoc-code .k{color:#008000; font-weight:bold}.pdoc-code .o{color:#666666}.pdoc-code .ch{color:#3D7B7B; font-style:italic}.pdoc-code .cm{color:#3D7B7B; font-style:italic}.pdoc-code .cp{color:#9C6500}.pdoc-code .cpf{color:#3D7B7B; font-style:italic}.pdoc-code .c1{color:#3D7B7B; font-style:italic}.pdoc-code .cs{color:#3D7B7B; font-style:italic}.pdoc-code .gd{color:#A00000}.pdoc-code .ge{font-style:italic}.pdoc-code .gr{color:#E40000}.pdoc-code .gh{color:#000080; font-weight:bold}.pdoc-code .gi{color:#008400}.pdoc-code .go{color:#717171}.pdoc-code .gp{color:#000080; font-weight:bold}.pdoc-code .gs{font-weight:bold}.pdoc-code .gu{color:#800080; font-weight:bold}.pdoc-code .gt{color:#0044DD}.pdoc-code .kc{color:#008000; font-weight:bold}.pdoc-code .kd{color:#008000; font-weight:bold}.pdoc-code .kn{color:#008000; font-weight:bold}.pdoc-code .kp{color:#008000}.pdoc-code .kr{color:#008000; font-weight:bold}.pdoc-code .kt{color:#B00040}.pdoc-code .m{color:#666666}.pdoc-code .s{color:#BA2121}.pdoc-code .na{color:#687822}.pdoc-code .nb{color:#008000}.pdoc-code .nc{color:#0000FF; font-weight:bold}.pdoc-code .no{color:#880000}.pdoc-code .nd{color:#AA22FF}.pdoc-code .ni{color:#717171; font-weight:bold}.pdoc-code .ne{color:#CB3F38; font-weight:bold}.pdoc-code .nf{color:#0000FF}.pdoc-code .nl{color:#767600}.pdoc-code .nn{color:#0000FF; font-weight:bold}.pdoc-code .nt{color:#008000; font-weight:bold}.pdoc-code .nv{color:#19177C}.pdoc-code .ow{color:#AA22FF; font-weight:bold}.pdoc-code .w{color:#bbbbbb}.pdoc-code .mb{color:#666666}.pdoc-code .mf{color:#666666}.pdoc-code .mh{color:#666666}.pdoc-code .mi{color:#666666}.pdoc-code .mo{color:#666666}.pdoc-code .sa{color:#BA2121}.pdoc-code .sb{color:#BA2121}.pdoc-code .sc{color:#BA2121}.pdoc-code .dl{color:#BA2121}.pdoc-code .sd{color:#BA2121; font-style:italic}.pdoc-code .s2{color:#BA2121}.pdoc-code .se{color:#AA5D1F; font-weight:bold}.pdoc-code .sh{color:#BA2121}.pdoc-code .si{color:#A45A77; font-weight:bold}.pdoc-code .sx{color:#008000}.pdoc-code .sr{color:#A45A77}.pdoc-code .s1{color:#BA2121}.pdoc-code .ss{color:#19177C}.pdoc-code .bp{color:#008000}.pdoc-code .fm{color:#0000FF}.pdoc-code .vc{color:#19177C}.pdoc-code .vg{color:#19177C}.pdoc-code .vi{color:#19177C}.pdoc-code .vm{color:#19177C}.pdoc-code .il{color:#666666}</style>
<style>/*! theme.css */:root{--pdoc-background:#fff;}.pdoc{--text:#212529;--muted:#6c757d;--link:#3660a5;--link-hover:#1659c5;--code:#f8f8f8;--active:#fff598;--accent:#eee;--accent2:#c1c1c1;--nav-hover:rgba(255, 255, 255, 0.5);--name:#0066BB;--def:#008800;--annotation:#007020;}</style>
<style>/*! layout.css */html, body{width:100%;height:100%;}html, main{scroll-behavior:smooth;}body{background-color:var(--pdoc-background);}@media (max-width:769px){#navtoggle{cursor:pointer;position:absolute;width:50px;height:40px;top:1rem;right:1rem;border-color:var(--text);color:var(--text);display:flex;opacity:0.8;z-index:999;}#navtoggle:hover{opacity:1;}#togglestate + div{display:none;}#togglestate:checked + div{display:inherit;}main, header{padding:2rem 3vw;}header + main{margin-top:-3rem;}.git-button{display:none !important;}nav input[type="search"]{max-width:77%;}nav input[type="search"]:first-child{margin-top:-6px;}nav input[type="search"]:valid ~ *{display:none !important;}}@media (min-width:770px){:root{--sidebar-width:clamp(12.5rem, 28vw, 22rem);}nav{position:fixed;overflow:auto;height:100vh;width:var(--sidebar-width);}main, header{padding:3rem 2rem 3rem calc(var(--sidebar-width) + 3rem);width:calc(54rem + var(--sidebar-width));max-width:100%;}header + main{margin-top:-4rem;}#navtoggle{display:none;}}#togglestate{position:absolute;height:0;opacity:0;}nav.pdoc{--pad:clamp(0.5rem, 2vw, 1.75rem);--indent:1.5rem;background-color:var(--accent);border-right:1px solid var(--accent2);box-shadow:0 0 20px rgba(50, 50, 50, .2) inset;padding:0 0 0 var(--pad);overflow-wrap:anywhere;scrollbar-width:thin; scrollbar-color:var(--accent2) transparent; z-index:1}nav.pdoc::-webkit-scrollbar{width:.4rem; }nav.pdoc::-webkit-scrollbar-thumb{background-color:var(--accent2); }nav.pdoc > div{padding:var(--pad) 0;}nav.pdoc .module-list-button{display:inline-flex;align-items:center;color:var(--text);border-color:var(--muted);margin-bottom:1rem;}nav.pdoc .module-list-button:hover{border-color:var(--text);}nav.pdoc input[type=search]{display:block;outline-offset:0;width:calc(100% - var(--pad));}nav.pdoc .logo{max-width:calc(100% - var(--pad));max-height:35vh;display:block;margin:0 auto 1rem;transform:translate(calc(-.5 * var(--pad)), 0);}nav.pdoc ul{list-style:none;padding-left:0;}nav.pdoc > div > ul{margin-left:calc(0px - var(--pad));}nav.pdoc li a{padding:.2rem 0 .2rem calc(var(--pad) + var(--indent));}nav.pdoc > div > ul > li > a{padding-left:var(--pad);}nav.pdoc li{transition:all 100ms;}nav.pdoc li:hover{background-color:var(--nav-hover);}nav.pdoc a, nav.pdoc a:hover{color:var(--text);}nav.pdoc a{display:block;}nav.pdoc > h2:first-of-type{margin-top:1.5rem;}nav.pdoc .class:before{content:"class ";color:var(--muted);}nav.pdoc .function:after{content:"()";color:var(--muted);}nav.pdoc footer:before{content:"";display:block;width:calc(100% - var(--pad));border-top:solid var(--accent2) 1px;margin-top:1.5rem;padding-top:.5rem;}nav.pdoc footer{font-size:small;}</style>
<style>/*! content.css */.pdoc{color:var(--text);box-sizing:border-box;line-height:1.5;background:none;}.pdoc .pdoc-button{cursor:pointer;display:inline-block;border:solid black 1px;border-radius:2px;font-size:.75rem;padding:calc(0.5em - 1px) 1em;transition:100ms all;}.pdoc .alert{padding:1rem 1rem 1rem calc(1.5rem + 24px);border:1px solid transparent;border-radius:.25rem;background-repeat:no-repeat;background-position:.75rem center;margin-bottom:1rem;}.pdoc .alert > em{display:none;}.pdoc .alert > *:last-child{margin-bottom:0;}.pdoc .alert.note{color:#084298;background-color:#cfe2ff;border-color:#b6d4fe;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23084298%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8%2016A8%208%200%201%200%208%200a8%208%200%200%200%200%2016zm.93-9.412-1%204.705c-.07.34.029.533.304.533.194%200%20.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703%200-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381%202.29-.287zM8%205.5a1%201%200%201%201%200-2%201%201%200%200%201%200%202z%22/%3E%3C/svg%3E");}.pdoc .alert.tip{color:#0a3622;background-color:#d1e7dd;border-color:#a3cfbb;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%230a3622%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M2%206a6%206%200%201%201%2010.174%204.31c-.203.196-.359.4-.453.619l-.762%201.769A.5.5%200%200%201%2010.5%2013a.5.5%200%200%201%200%201%20.5.5%200%200%201%200%201l-.224.447a1%201%200%200%201-.894.553H6.618a1%201%200%200%201-.894-.553L5.5%2015a.5.5%200%200%201%200-1%20.5.5%200%200%201%200-1%20.5.5%200%200%201-.46-.302l-.761-1.77a2%202%200%200%200-.453-.618A5.98%205.98%200%200%201%202%206m6-5a5%205%200%200%200-3.479%208.592c.263.254.514.564.676.941L5.83%2012h4.342l.632-1.467c.162-.377.413-.687.676-.941A5%205%200%200%200%208%201%22/%3E%3C/svg%3E");}.pdoc .alert.important{color:#055160;background-color:#cff4fc;border-color:#9eeaf9;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23055160%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M2%200a2%202%200%200%200-2%202v12a2%202%200%200%200%202%202h12a2%202%200%200%200%202-2V2a2%202%200%200%200-2-2zm6%204c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%204.995A.905.905%200%200%201%208%204m.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2%22/%3E%3C/svg%3E");}.pdoc .alert.warning{color:#664d03;background-color:#fff3cd;border-color:#ffecb5;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23664d03%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8.982%201.566a1.13%201.13%200%200%200-1.96%200L.165%2013.233c-.457.778.091%201.767.98%201.767h13.713c.889%200%201.438-.99.98-1.767L8.982%201.566zM8%205c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%205.995A.905.905%200%200%201%208%205zm.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2z%22/%3E%3C/svg%3E");}.pdoc .alert.caution{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M11.46.146A.5.5%200%200%200%2011.107%200H4.893a.5.5%200%200%200-.353.146L.146%204.54A.5.5%200%200%200%200%204.893v6.214a.5.5%200%200%200%20.146.353l4.394%204.394a.5.5%200%200%200%20.353.146h6.214a.5.5%200%200%200%20.353-.146l4.394-4.394a.5.5%200%200%200%20.146-.353V4.893a.5.5%200%200%200-.146-.353zM8%204c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%204.995A.905.905%200%200%201%208%204m.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2%22/%3E%3C/svg%3E");}.pdoc .alert.danger{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M5.52.359A.5.5%200%200%201%206%200h4a.5.5%200%200%201%20.474.658L8.694%206H12.5a.5.5%200%200%201%20.395.807l-7%209a.5.5%200%200%201-.873-.454L6.823%209.5H3.5a.5.5%200%200%201-.48-.641l2.5-8.5z%22/%3E%3C/svg%3E");}.pdoc .visually-hidden{position:absolute !important;width:1px !important;height:1px !important;padding:0 !important;margin:-1px !important;overflow:hidden !important;clip:rect(0, 0, 0, 0) !important;white-space:nowrap !important;border:0 !important;}.pdoc h1, .pdoc h2, .pdoc h3{font-weight:300;margin:.3em 0;padding:.2em 0;}.pdoc > section:not(.module-info) h1{font-size:1.5rem;font-weight:500;}.pdoc > section:not(.module-info) h2{font-size:1.4rem;font-weight:500;}.pdoc > section:not(.module-info) h3{font-size:1.3rem;font-weight:500;}.pdoc > section:not(.module-info) h4{font-size:1.2rem;}.pdoc > section:not(.module-info) h5{font-size:1.1rem;}.pdoc a{text-decoration:none;color:var(--link);}.pdoc a:hover{color:var(--link-hover);}.pdoc blockquote{margin-left:2rem;}.pdoc pre{border-top:1px solid var(--accent2);border-bottom:1px solid var(--accent2);margin-top:0;margin-bottom:1em;padding:.5rem 0 .5rem .5rem;overflow-x:auto;background-color:var(--code);}.pdoc code{color:var(--text);padding:.2em .4em;margin:0;font-size:85%;background-color:var(--accent);border-radius:6px;}.pdoc a > code{color:inherit;}.pdoc pre > code{display:inline-block;font-size:inherit;background:none;border:none;padding:0;}.pdoc > section:not(.module-info){margin-bottom:1.5rem;}.pdoc .modulename{margin-top:0;font-weight:bold;}.pdoc .modulename a{color:var(--link);transition:100ms all;}.pdoc .git-button{float:right;border:solid var(--link) 1px;}.pdoc .git-button:hover{background-color:var(--link);color:var(--pdoc-background);}.view-source-toggle-state,.view-source-toggle-state ~ .pdoc-code{display:none;}.view-source-toggle-state:checked ~ .pdoc-code{display:block;}.view-source-button{display:inline-block;float:right;font-size:.75rem;line-height:1.5rem;color:var(--muted);padding:0 .4rem 0 1.3rem;cursor:pointer;text-indent:-2px;}.view-source-button > span{visibility:hidden;}.module-info .view-source-button{float:none;display:flex;justify-content:flex-end;margin:-1.2rem .4rem -.2rem 0;}.view-source-button::before{position:absolute;content:"View Source";display:list-item;list-style-type:disclosure-closed;}.view-source-toggle-state:checked ~ .attr .view-source-button::before,.view-source-toggle-state:checked ~ .view-source-button::before{list-style-type:disclosure-open;}.pdoc .docstring{margin-bottom:1.5rem;}.pdoc section:not(.module-info) .docstring{margin-left:clamp(0rem, 5vw - 2rem, 1rem);}.pdoc .docstring .pdoc-code{margin-left:1em;margin-right:1em;}.pdoc h1:target,.pdoc h2:target,.pdoc h3:target,.pdoc h4:target,.pdoc h5:target,.pdoc h6:target,.pdoc .pdoc-code > pre > span:target{background-color:var(--active);box-shadow:-1rem 0 0 0 var(--active);}.pdoc .pdoc-code > pre > span:target{display:block;}.pdoc div:target > .attr,.pdoc section:target > .attr,.pdoc dd:target > a{background-color:var(--active);}.pdoc *{scroll-margin:2rem;}.pdoc .pdoc-code .linenos{user-select:none;}.pdoc .attr:hover{filter:contrast(0.95);}.pdoc section, .pdoc .classattr{position:relative;}.pdoc .headerlink{--width:clamp(1rem, 3vw, 2rem);position:absolute;top:0;left:calc(0rem - var(--width));transition:all 100ms ease-in-out;opacity:0;}.pdoc .headerlink::before{content:"#";display:block;text-align:center;width:var(--width);height:2.3rem;line-height:2.3rem;font-size:1.5rem;}.pdoc .attr:hover ~ .headerlink,.pdoc *:target > .headerlink,.pdoc .headerlink:hover{opacity:1;}.pdoc .attr{display:block;margin:.5rem 0 .5rem;padding:.4rem .4rem .4rem 1rem;background-color:var(--accent);overflow-x:auto;}.pdoc .classattr{margin-left:2rem;}.pdoc .decorator-deprecated{color:#842029;}.pdoc .decorator-deprecated ~ span{filter:grayscale(1) opacity(0.8);}.pdoc .name{color:var(--name);font-weight:bold;}.pdoc .def{color:var(--def);font-weight:bold;}.pdoc .signature{background-color:transparent;}.pdoc .param, .pdoc .return-annotation{white-space:pre;}.pdoc .signature.multiline .param{display:block;}.pdoc .signature.condensed .param{display:inline-block;}.pdoc .annotation{color:var(--annotation);}.pdoc .view-value-toggle-state,.pdoc .view-value-toggle-state ~ .default_value{display:none;}.pdoc .view-value-toggle-state:checked ~ .default_value{display:inherit;}.pdoc .view-value-button{font-size:.5rem;vertical-align:middle;border-style:dashed;margin-top:-0.1rem;}.pdoc .view-value-button:hover{background:white;}.pdoc .view-value-button::before{content:"show";text-align:center;width:2.2em;display:inline-block;}.pdoc .view-value-toggle-state:checked ~ .view-value-button::before{content:"hide";}.pdoc .inherited{margin-left:2rem;}.pdoc .inherited dt{font-weight:700;}.pdoc .inherited dt, .pdoc .inherited dd{display:inline;margin-left:0;margin-bottom:.5rem;}.pdoc .inherited dd:not(:last-child):after{content:", ";}.pdoc .inherited .class:before{content:"class ";}.pdoc .inherited .function a:after{content:"()";}.pdoc .search-result .docstring{overflow:auto;max-height:25vh;}.pdoc .search-result.focused > .attr{background-color:var(--active);}.pdoc .attribution{margin-top:2rem;display:block;opacity:0.5;transition:all 200ms;filter:grayscale(100%);}.pdoc .attribution:hover{opacity:1;filter:grayscale(0%);}.pdoc .attribution img{margin-left:5px;height:35px;vertical-align:middle;width:70px;transition:all 200ms;}.pdoc table{display:block;width:max-content;max-width:100%;overflow:auto;margin-bottom:1rem;}.pdoc table th{font-weight:600;}.pdoc table th, .pdoc table td{padding:6px 13px;border:1px solid var(--accent2);}</style>
<style>/*! custom.css */</style></head>
<body>
<nav class="pdoc">
<label id="navtoggle" for="togglestate" class="pdoc-button"><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke-linecap='round' stroke="currentColor" stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg></label>
<input id="togglestate" type="checkbox" aria-hidden="true" tabindex="-1">
<div> <a class="pdoc-button module-list-button" href="../vimgolf_gym.html">
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-box-arrow-in-left" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M10 3.5a.5.5 0 0 0-.5-.5h-8a.5.5 0 0 0-.5.5v9a.5.5 0 0 0 .5.5h8a.5.5 0 0 0 .5-.5v-2a.5.5 0 0 1 1 0v2A1.5 1.5 0 0 1 9.5 14h-8A1.5 1.5 0 0 1 0 12.5v-9A1.5 1.5 0 0 1 1.5 2h8A1.5 1.5 0 0 1 11 3.5v2a.5.5 0 0 1-1 0v-2z"/>
<path fill-rule="evenodd" d="M4.146 8.354a.5.5 0 0 1 0-.708l3-3a.5.5 0 1 1 .708.708L5.707 7.5H14.5a.5.5 0 0 1 0 1H5.707l2.147 2.146a.5.5 0 0 1-.708.708l-3-3z"/>
</svg> vimgolf_gym</a>
<input type="search" placeholder="Search..." role="searchbox" aria-label="search"
pattern=".+" required>
<h2>API Documentation</h2>
<ul class="memberlist">
<li>
<a class="function" href="#make">make</a>
</li>
<li>
<a class="function" href="#list_local_challenge_ids">list_local_challenge_ids</a>
</li>
<li>
<a class="function" href="#get_local_challenge_definition">get_local_challenge_definition</a>
</li>
<li>
<a class="function" href="#get_local_challenge_metadata">get_local_challenge_metadata</a>
</li>
<li>
<a class="function" href="#get_local_challenge_worst_solution">get_local_challenge_worst_solution</a>
</li>
<li>
<a class="function" href="#get_local_challenge_worst_solution_header">get_local_challenge_worst_solution_header</a>
</li>
<li>
<a class="class" href="#VimGolfEnv">VimGolfEnv</a>
<ul class="memberlist">
<li>
<a class="function" href="#VimGolfEnv.__init__">VimGolfEnv</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.use_docker">use_docker</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.input_file">input_file</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.output_file">output_file</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.log_buffer">log_buffer</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.init_keys">init_keys</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.log_directory">log_directory</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.log_file">log_file</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.buffer_file">buffer_file</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.command">command</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.width">width</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.height">height</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.executor">executor</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.log_watcher">log_watcher</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.buffer">buffer</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.act">act</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.success">success</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.get_best_success_result">get_best_success_result</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.get_last_success_result">get_last_success_result</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.results">results</a>
</li>
<li>
<a class="variable" href="#VimGolfEnv.success_results">success_results</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.create_executor_and_log_watcher">create_executor_and_log_watcher</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.reset">reset</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.render">render</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.screenshot">screenshot</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.verify_keys">verify_keys</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.close">close</a>
</li>
<li>
<a class="function" href="#VimGolfEnv.calculate_relative_inverse_score">calculate_relative_inverse_score</a>
</li>
</ul>
</li>
</ul>
<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
alt="pdoc logo"
src="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
</a>
</div>
</nav>
<main class="pdoc">
<section class="module-info">
<h1 class="modulename">
<a href="./../vimgolf_gym.html">vimgolf_gym</a><wbr>.lib </h1>
<div class="docstring"><p>Library of vimgolf-gym</p>
</div>
<input id="mod-lib-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<label class="view-source-button" for="mod-lib-view-source"><span>View Source</span></label>
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="sd">"""</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a><span class="sd">Library of vimgolf-gym</span>
</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="sd">"""</span>
</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a>
</span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a><span class="c1"># TODO: implement a openai-gym style interface</span>
</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a><span class="c1"># reference link: https://github.com/Farama-Foundation/Gymnasium</span>
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a>
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="c1"># TODO: implement a gradual scoring system by comparing the buffer with the target output, extracting the vim edit buffer in the middle of execution</span>
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a>
</span><span id="L-10"><a href="#L-10"><span class="linenos"> 10</span></a><span class="c1"># Vim API reference:</span>
</span><span id="L-11"><a href="#L-11"><span class="linenos"> 11</span></a><span class="c1"># https://github.com/LachlanGray/vim-agent</span>
</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a><span class="c1"># https://github.com/nsbradford/VimGPT</span>
</span><span id="L-13"><a href="#L-13"><span class="linenos"> 13</span></a>
</span><span id="L-14"><a href="#L-14"><span class="linenos"> 14</span></a><span class="c1"># TODO: dockerize the executor part, push the image, offer an option or environment variable to use dockerized executor</span>
</span><span id="L-15"><a href="#L-15"><span class="linenos"> 15</span></a>
</span><span id="L-16"><a href="#L-16"><span class="linenos"> 16</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">atexit</span>
</span><span id="L-17"><a href="#L-17"><span class="linenos"> 17</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
</span><span id="L-18"><a href="#L-18"><span class="linenos"> 18</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">pathlib</span>
</span><span id="L-19"><a href="#L-19"><span class="linenos"> 19</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">shutil</span>
</span><span id="L-20"><a href="#L-20"><span class="linenos"> 20</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
</span><span id="L-21"><a href="#L-21"><span class="linenos"> 21</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">tempfile</span>
</span><span id="L-22"><a href="#L-22"><span class="linenos"> 22</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
</span><span id="L-23"><a href="#L-23"><span class="linenos"> 23</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
</span><span id="L-24"><a href="#L-24"><span class="linenos"> 24</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">zipfile</span>
</span><span id="L-25"><a href="#L-25"><span class="linenos"> 25</span></a>
</span><span id="L-26"><a href="#L-26"><span class="linenos"> 26</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">PIL.Image</span>
</span><span id="L-27"><a href="#L-27"><span class="linenos"> 27</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
</span><span id="L-28"><a href="#L-28"><span class="linenos"> 28</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">uuid</span>
</span><span id="L-29"><a href="#L-29"><span class="linenos"> 29</span></a>
</span><span id="L-30"><a href="#L-30"><span class="linenos"> 30</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">vimgolf.vimgolf</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">vimgolf</span>
</span><span id="L-31"><a href="#L-31"><span class="linenos"> 31</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">vimgolf_gym.dataclasses</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">dataclasses</span>
</span><span id="L-32"><a href="#L-32"><span class="linenos"> 32</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">vimgolf_gym.log_parser</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">log_parser</span>
</span><span id="L-33"><a href="#L-33"><span class="linenos"> 33</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">vimgolf_gym.terminal_executor</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">terminal_executor</span>
</span><span id="L-34"><a href="#L-34"><span class="linenos"> 34</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">vimgolf_gym._vimrc</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
</span><span id="L-35"><a href="#L-35"><span class="linenos"> 35</span></a> <span class="n">_prepare_cybergod_vimrc_with_buffer_file</span><span class="p">,</span>
</span><span id="L-36"><a href="#L-36"><span class="linenos"> 36</span></a> <span class="n">_CYBERGOD_VIMGOLF_VIMRC_FILEPATH</span><span class="p">,</span>
</span><span id="L-37"><a href="#L-37"><span class="linenos"> 37</span></a><span class="p">)</span>
</span><span id="L-38"><a href="#L-38"><span class="linenos"> 38</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">subprocess</span>
</span><span id="L-39"><a href="#L-39"><span class="linenos"> 39</span></a>
</span><span id="L-40"><a href="#L-40"><span class="linenos"> 40</span></a><span class="n">_HOMEDIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s2">"~"</span><span class="p">)</span>
</span><span id="L-41"><a href="#L-41"><span class="linenos"> 41</span></a>
</span><span id="L-42"><a href="#L-42"><span class="linenos"> 42</span></a><span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-43"><a href="#L-43"><span class="linenos"> 43</span></a> <span class="n">_HOMEDIR</span><span class="p">,</span> <span class="s2">".cache"</span><span class="p">,</span> <span class="s2">"cybergod-vimgolf-dataset"</span>
</span><span id="L-44"><a href="#L-44"><span class="linenos"> 44</span></a><span class="p">)</span>
</span><span id="L-45"><a href="#L-45"><span class="linenos"> 45</span></a>
</span><span id="L-46"><a href="#L-46"><span class="linenos"> 46</span></a><span class="n">_CYBERGOD_VIMGOLF_GYM_DATASET_DOWNLOADED</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-47"><a href="#L-47"><span class="linenos"> 47</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span> <span class="s2">"DATASET_DOWNLOADED"</span>
</span><span id="L-48"><a href="#L-48"><span class="linenos"> 48</span></a><span class="p">)</span> <span class="c1"># a flag to indicate whether the dataset has been downloaded</span>
</span><span id="L-49"><a href="#L-49"><span class="linenos"> 49</span></a>
</span><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a><span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span> <span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span><span id="L-51"><a href="#L-51"><span class="linenos"> 51</span></a>
</span><span id="L-52"><a href="#L-52"><span class="linenos"> 52</span></a><span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="L-53"><a href="#L-53"><span class="linenos"> 53</span></a> <span class="s2">"make"</span><span class="p">,</span>
</span><span id="L-54"><a href="#L-54"><span class="linenos"> 54</span></a> <span class="s2">"list_local_challenge_ids"</span><span class="p">,</span>
</span><span id="L-55"><a href="#L-55"><span class="linenos"> 55</span></a> <span class="s2">"get_local_challenge_definition"</span><span class="p">,</span>
</span><span id="L-56"><a href="#L-56"><span class="linenos"> 56</span></a> <span class="s2">"get_local_challenge_metadata"</span><span class="p">,</span>
</span><span id="L-57"><a href="#L-57"><span class="linenos"> 57</span></a> <span class="s2">"get_local_challenge_worst_solution"</span><span class="p">,</span>
</span><span id="L-58"><a href="#L-58"><span class="linenos"> 58</span></a> <span class="s2">"get_local_challenge_worst_solution_header"</span><span class="p">,</span>
</span><span id="L-59"><a href="#L-59"><span class="linenos"> 59</span></a> <span class="s2">"VimGolfEnv"</span><span class="p">,</span>
</span><span id="L-60"><a href="#L-60"><span class="linenos"> 60</span></a><span class="p">]</span>
</span><span id="L-61"><a href="#L-61"><span class="linenos"> 61</span></a>
</span><span id="L-62"><a href="#L-62"><span class="linenos"> 62</span></a>
</span><span id="L-63"><a href="#L-63"><span class="linenos"> 63</span></a><span class="k">class</span><span class="w"> </span><span class="nc">DatasetInitError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
</span><span id="L-64"><a href="#L-64"><span class="linenos"> 64</span></a> <span class="k">pass</span>
</span><span id="L-65"><a href="#L-65"><span class="linenos"> 65</span></a>
</span><span id="L-66"><a href="#L-66"><span class="linenos"> 66</span></a>
</span><span id="L-67"><a href="#L-67"><span class="linenos"> 67</span></a><span class="k">def</span><span class="w"> </span><span class="nf">assert_challenge_id_length</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
</span><span id="L-68"><a href="#L-68"><span class="linenos"> 68</span></a><span class="w"> </span><span class="sd">"""Assert the challenge_id length to be 24"""</span>
</span><span id="L-69"><a href="#L-69"><span class="linenos"> 69</span></a> <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span> <span class="o">==</span> <span class="mi">24</span>
</span><span id="L-70"><a href="#L-70"><span class="linenos"> 70</span></a>
</span><span id="L-71"><a href="#L-71"><span class="linenos"> 71</span></a>
</span><span id="L-72"><a href="#L-72"><span class="linenos"> 72</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make</span><span class="p">(</span>
</span><span id="L-73"><a href="#L-73"><span class="linenos"> 73</span></a> <span class="n">env_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="L-74"><a href="#L-74"><span class="linenos"> 74</span></a> <span class="n">custom_challenge</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfCustomChallenge</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
</span><span id="L-75"><a href="#L-75"><span class="linenos"> 75</span></a> <span class="n">use_docker</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="L-76"><a href="#L-76"><span class="linenos"> 76</span></a> <span class="n">log_buffer</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="L-77"><a href="#L-77"><span class="linenos"> 77</span></a><span class="p">)</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="L-78"><a href="#L-78"><span class="linenos"> 78</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-79"><a href="#L-79"><span class="linenos"> 79</span></a><span class="sd"> Create a VimGolf environment.</span>
</span><span id="L-80"><a href="#L-80"><span class="linenos"> 80</span></a>
</span><span id="L-81"><a href="#L-81"><span class="linenos"> 81</span></a><span class="sd"> The env_name can be one of the following:</span>
</span><span id="L-82"><a href="#L-82"><span class="linenos"> 82</span></a><span class="sd"> - `vimgolf-test`: A simple test environment.</span>
</span><span id="L-83"><a href="#L-83"><span class="linenos"> 83</span></a><span class="sd"> - `vimgolf-local-<challenge_id>`: A local environment for a specific challenge.</span>
</span><span id="L-84"><a href="#L-84"><span class="linenos"> 84</span></a><span class="sd"> - `vimgolf-online-<challenge_id>`: An online environment for a specific challenge.</span>
</span><span id="L-85"><a href="#L-85"><span class="linenos"> 85</span></a><span class="sd"> - `vimgolf-custom`: A custom environment. The `custom_challenge` parameter will be used.</span>
</span><span id="L-86"><a href="#L-86"><span class="linenos"> 86</span></a>
</span><span id="L-87"><a href="#L-87"><span class="linenos"> 87</span></a><span class="sd"> Args:</span>
</span><span id="L-88"><a href="#L-88"><span class="linenos"> 88</span></a><span class="sd"> env_name (str): The name of the environment to create.</span>
</span><span id="L-89"><a href="#L-89"><span class="linenos"> 89</span></a><span class="sd"> use_docker (bool, optional): Whether to use a dockerized executor. Defaults to False.</span>
</span><span id="L-90"><a href="#L-90"><span class="linenos"> 90</span></a><span class="sd"> log_buffer (bool, optional): Whether to log the editor buffer or not. Defaults to False.</span>
</span><span id="L-91"><a href="#L-91"><span class="linenos"> 91</span></a><span class="sd"> custom_challenge (Optional[VimGolfCustomChallenge], optional): The custom challenge to use. Defaults to None.</span>
</span><span id="L-92"><a href="#L-92"><span class="linenos"> 92</span></a>
</span><span id="L-93"><a href="#L-93"><span class="linenos"> 93</span></a><span class="sd"> Raises:</span>
</span><span id="L-94"><a href="#L-94"><span class="linenos"> 94</span></a><span class="sd"> NotImplementedError: If the environment name is not recognized.</span>
</span><span id="L-95"><a href="#L-95"><span class="linenos"> 95</span></a>
</span><span id="L-96"><a href="#L-96"><span class="linenos"> 96</span></a><span class="sd"> Returns:</span>
</span><span id="L-97"><a href="#L-97"><span class="linenos"> 97</span></a><span class="sd"> VimGolfEnv: The created environment</span>
</span><span id="L-98"><a href="#L-98"><span class="linenos"> 98</span></a><span class="sd"> """</span>
</span><span id="L-99"><a href="#L-99"><span class="linenos"> 99</span></a> <span class="k">if</span> <span class="n">use_docker</span><span class="p">:</span>
</span><span id="L-100"><a href="#L-100"><span class="linenos">100</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_USE_DOCKER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span>
</span><span id="L-101"><a href="#L-101"><span class="linenos">101</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-102"><a href="#L-102"><span class="linenos">102</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_USE_DOCKER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"0"</span>
</span><span id="L-103"><a href="#L-103"><span class="linenos">103</span></a>
</span><span id="L-104"><a href="#L-104"><span class="linenos">104</span></a> <span class="k">if</span> <span class="n">log_buffer</span><span class="p">:</span>
</span><span id="L-105"><a href="#L-105"><span class="linenos">105</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_LOG_BUFFER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span>
</span><span id="L-106"><a href="#L-106"><span class="linenos">106</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-107"><a href="#L-107"><span class="linenos">107</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_LOG_BUFFER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"0"</span>
</span><span id="L-108"><a href="#L-108"><span class="linenos">108</span></a>
</span><span id="L-109"><a href="#L-109"><span class="linenos">109</span></a> <span class="k">if</span> <span class="n">env_name</span> <span class="o">==</span> <span class="s2">"vimgolf-test"</span><span class="p">:</span>
</span><span id="L-110"><a href="#L-110"><span class="linenos">110</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_test</span><span class="p">()</span>
</span><span id="L-111"><a href="#L-111"><span class="linenos">111</span></a> <span class="k">elif</span> <span class="n">env_name</span> <span class="o">==</span> <span class="s2">"vimgolf-custom"</span><span class="p">:</span>
</span><span id="L-112"><a href="#L-112"><span class="linenos">112</span></a> <span class="k">assert</span> <span class="p">(</span>
</span><span id="L-113"><a href="#L-113"><span class="linenos">113</span></a> <span class="n">custom_challenge</span>
</span><span id="L-114"><a href="#L-114"><span class="linenos">114</span></a> <span class="p">),</span> <span class="s2">"custom_challenge must be provided for vimgolf-custom environment"</span>
</span><span id="L-115"><a href="#L-115"><span class="linenos">115</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_env_with_text</span><span class="p">(</span>
</span><span id="L-116"><a href="#L-116"><span class="linenos">116</span></a> <span class="nb">input</span><span class="o">=</span><span class="n">custom_challenge</span><span class="o">.</span><span class="n">input</span><span class="p">,</span> <span class="n">output</span><span class="o">=</span><span class="n">custom_challenge</span><span class="o">.</span><span class="n">output</span>
</span><span id="L-117"><a href="#L-117"><span class="linenos">117</span></a> <span class="p">)</span>
</span><span id="L-118"><a href="#L-118"><span class="linenos">118</span></a> <span class="k">elif</span> <span class="n">env_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"vimgolf-local-"</span><span class="p">):</span>
</span><span id="L-119"><a href="#L-119"><span class="linenos">119</span></a> <span class="n">challenge_id</span> <span class="o">=</span> <span class="n">env_name</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"vimgolf-local-"</span><span class="p">)</span> <span class="p">:]</span>
</span><span id="L-120"><a href="#L-120"><span class="linenos">120</span></a> <span class="n">assert_challenge_id_length</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="L-121"><a href="#L-121"><span class="linenos">121</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_offline_with_cybergod_dataset</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="L-122"><a href="#L-122"><span class="linenos">122</span></a> <span class="k">elif</span> <span class="n">env_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"vimgolf-online-"</span><span class="p">):</span>
</span><span id="L-123"><a href="#L-123"><span class="linenos">123</span></a> <span class="n">challenge_id</span> <span class="o">=</span> <span class="n">env_name</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"vimgolf-online-"</span><span class="p">)</span> <span class="p">:]</span>
</span><span id="L-124"><a href="#L-124"><span class="linenos">124</span></a> <span class="n">assert_challenge_id_length</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="L-125"><a href="#L-125"><span class="linenos">125</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_online</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="L-126"><a href="#L-126"><span class="linenos">126</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-127"><a href="#L-127"><span class="linenos">127</span></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span>
</span><span id="L-128"><a href="#L-128"><span class="linenos">128</span></a> <span class="k">return</span> <span class="n">env</span>
</span><span id="L-129"><a href="#L-129"><span class="linenos">129</span></a>
</span><span id="L-130"><a href="#L-130"><span class="linenos">130</span></a>
</span><span id="L-131"><a href="#L-131"><span class="linenos">131</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make_test</span><span class="p">()</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="L-132"><a href="#L-132"><span class="linenos">132</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-133"><a href="#L-133"><span class="linenos">133</span></a><span class="sd"> Create an environment for a simple test challenge.</span>
</span><span id="L-134"><a href="#L-134"><span class="linenos">134</span></a>
</span><span id="L-135"><a href="#L-135"><span class="linenos">135</span></a><span class="sd"> The test challenge is about typing "hello world" into the buffer and then saving and quitting vim.</span>
</span><span id="L-136"><a href="#L-136"><span class="linenos">136</span></a><span class="sd"> The expected solution is "hello world\nhello world\n".</span>
</span><span id="L-137"><a href="#L-137"><span class="linenos">137</span></a><span class="sd"> """</span>
</span><span id="L-138"><a href="#L-138"><span class="linenos">138</span></a> <span class="n">input_text</span> <span class="o">=</span> <span class="s2">""</span>
</span><span id="L-139"><a href="#L-139"><span class="linenos">139</span></a> <span class="n">output_text</span> <span class="o">=</span> <span class="s2">"hello world</span><span class="se">\n</span><span class="s2">hello world</span><span class="se">\n</span><span class="s2">"</span>
</span><span id="L-140"><a href="#L-140"><span class="linenos">140</span></a> <span class="k">return</span> <span class="n">make_env_with_text</span><span class="p">(</span><span class="n">input_text</span><span class="p">,</span> <span class="n">output_text</span><span class="p">)</span>
</span><span id="L-141"><a href="#L-141"><span class="linenos">141</span></a>
</span><span id="L-142"><a href="#L-142"><span class="linenos">142</span></a>
</span><span id="L-143"><a href="#L-143"><span class="linenos">143</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make_env_with_text</span><span class="p">(</span><span class="n">input_text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">output_text</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="L-144"><a href="#L-144"><span class="linenos">144</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-145"><a href="#L-145"><span class="linenos">145</span></a><span class="sd"> Create a VimGolfEnv with given input and output text.</span>
</span><span id="L-146"><a href="#L-146"><span class="linenos">146</span></a>
</span><span id="L-147"><a href="#L-147"><span class="linenos">147</span></a><span class="sd"> Creates a temporary directory and two files, one for the input and one for the output.</span>
</span><span id="L-148"><a href="#L-148"><span class="linenos">148</span></a><span class="sd"> Then it calls make_offline with the paths of the two files.</span>
</span><span id="L-149"><a href="#L-149"><span class="linenos">149</span></a>
</span><span id="L-150"><a href="#L-150"><span class="linenos">150</span></a><span class="sd"> Args:</span>
</span><span id="L-151"><a href="#L-151"><span class="linenos">151</span></a><span class="sd"> input_text (str): The starting code.</span>
</span><span id="L-152"><a href="#L-152"><span class="linenos">152</span></a><span class="sd"> output_text (str): The expected solution code.</span>
</span><span id="L-153"><a href="#L-153"><span class="linenos">153</span></a>
</span><span id="L-154"><a href="#L-154"><span class="linenos">154</span></a><span class="sd"> Returns:</span>
</span><span id="L-155"><a href="#L-155"><span class="linenos">155</span></a><span class="sd"> VimGolfEnv: The environment object.</span>
</span><span id="L-156"><a href="#L-156"><span class="linenos">156</span></a><span class="sd"> """</span>
</span><span id="L-157"><a href="#L-157"><span class="linenos">157</span></a> <span class="n">tempdir</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span>
</span><span id="L-158"><a href="#L-158"><span class="linenos">158</span></a> <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">tempdir</span><span class="o">.</span><span class="n">cleanup</span><span class="p">)</span>
</span><span id="L-159"><a href="#L-159"><span class="linenos">159</span></a> <span class="n">input_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tempdir</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"input.txt"</span><span class="p">)</span>
</span><span id="L-160"><a href="#L-160"><span class="linenos">160</span></a> <span class="n">output_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tempdir</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"output.txt"</span><span class="p">)</span>
</span><span id="L-161"><a href="#L-161"><span class="linenos">161</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">input_file</span><span class="p">,</span> <span class="s2">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-162"><a href="#L-162"><span class="linenos">162</span></a> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">input_text</span><span class="p">)</span>
</span><span id="L-163"><a href="#L-163"><span class="linenos">163</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">output_file</span><span class="p">,</span> <span class="s2">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-164"><a href="#L-164"><span class="linenos">164</span></a> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">output_text</span><span class="p">)</span>
</span><span id="L-165"><a href="#L-165"><span class="linenos">165</span></a> <span class="k">return</span> <span class="n">make_offline</span><span class="p">(</span><span class="n">input_file</span><span class="p">,</span> <span class="n">output_file</span><span class="p">)</span>
</span><span id="L-166"><a href="#L-166"><span class="linenos">166</span></a>
</span><span id="L-167"><a href="#L-167"><span class="linenos">167</span></a>
</span><span id="L-168"><a href="#L-168"><span class="linenos">168</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make_offline</span><span class="p">(</span><span class="n">input_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">output_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="L-169"><a href="#L-169"><span class="linenos">169</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-170"><a href="#L-170"><span class="linenos">170</span></a><span class="sd"> Create an environment from a VimGolf challenge given as a local file.</span>
</span><span id="L-171"><a href="#L-171"><span class="linenos">171</span></a>
</span><span id="L-172"><a href="#L-172"><span class="linenos">172</span></a><span class="sd"> Args:</span>
</span><span id="L-173"><a href="#L-173"><span class="linenos">173</span></a><span class="sd"> input_file (str): Path to the file containing the starting code.</span>
</span><span id="L-174"><a href="#L-174"><span class="linenos">174</span></a><span class="sd"> output_file (str): Path to the file containing the expected solution code.</span>
</span><span id="L-175"><a href="#L-175"><span class="linenos">175</span></a>
</span><span id="L-176"><a href="#L-176"><span class="linenos">176</span></a><span class="sd"> Returns:</span>
</span><span id="L-177"><a href="#L-177"><span class="linenos">177</span></a><span class="sd"> VimGolfEnv: An environment for the given challenge.</span>
</span><span id="L-178"><a href="#L-178"><span class="linenos">178</span></a><span class="sd"> """</span>
</span><span id="L-179"><a href="#L-179"><span class="linenos">179</span></a> <span class="n">use_docker</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"VIMGOLF_GYM_USE_DOCKER"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"1"</span>
</span><span id="L-180"><a href="#L-180"><span class="linenos">180</span></a> <span class="n">log_buffer</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"VIMGOLF_GYM_LOG_BUFFER"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"1"</span>
</span><span id="L-181"><a href="#L-181"><span class="linenos">181</span></a> <span class="k">return</span> <span class="n">VimGolfEnv</span><span class="p">(</span>
</span><span id="L-182"><a href="#L-182"><span class="linenos">182</span></a> <span class="n">input_file</span><span class="o">=</span><span class="n">input_file</span><span class="p">,</span>
</span><span id="L-183"><a href="#L-183"><span class="linenos">183</span></a> <span class="n">output_file</span><span class="o">=</span><span class="n">output_file</span><span class="p">,</span>
</span><span id="L-184"><a href="#L-184"><span class="linenos">184</span></a> <span class="n">use_docker</span><span class="o">=</span><span class="n">use_docker</span><span class="p">,</span>
</span><span id="L-185"><a href="#L-185"><span class="linenos">185</span></a> <span class="n">log_buffer</span><span class="o">=</span><span class="n">log_buffer</span><span class="p">,</span>
</span><span id="L-186"><a href="#L-186"><span class="linenos">186</span></a> <span class="p">)</span>
</span><span id="L-187"><a href="#L-187"><span class="linenos">187</span></a>
</span><span id="L-188"><a href="#L-188"><span class="linenos">188</span></a>
</span><span id="L-189"><a href="#L-189"><span class="linenos">189</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make_online</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="L-190"><a href="#L-190"><span class="linenos">190</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-191"><a href="#L-191"><span class="linenos">191</span></a><span class="sd"> Create an environment from a VimGolf challenge online.</span>
</span><span id="L-192"><a href="#L-192"><span class="linenos">192</span></a>
</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a><span class="sd"> Given a challenge_id, obtain the challenge definition from the VimGolf website</span>
</span><span id="L-194"><a href="#L-194"><span class="linenos">194</span></a><span class="sd"> and create an environment out of it.</span>
</span><span id="L-195"><a href="#L-195"><span class="linenos">195</span></a>
</span><span id="L-196"><a href="#L-196"><span class="linenos">196</span></a><span class="sd"> Args:</span>
</span><span id="L-197"><a href="#L-197"><span class="linenos">197</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="L-198"><a href="#L-198"><span class="linenos">198</span></a>
</span><span id="L-199"><a href="#L-199"><span class="linenos">199</span></a><span class="sd"> Returns:</span>
</span><span id="L-200"><a href="#L-200"><span class="linenos">200</span></a><span class="sd"> VimGolfEnv: An environment for the given challenge.</span>
</span><span id="L-201"><a href="#L-201"><span class="linenos">201</span></a><span class="sd"> """</span>
</span><span id="L-202"><a href="#L-202"><span class="linenos">202</span></a> <span class="n">challenge_url</span> <span class="o">=</span> <span class="n">vimgolf</span><span class="o">.</span><span class="n">get_challenge_url</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="L-203"><a href="#L-203"><span class="linenos">203</span></a> <span class="n">challenge_data</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">challenge_url</span><span class="p">)</span><span class="o">.</span><span class="n">content</span>
</span><span id="L-204"><a href="#L-204"><span class="linenos">204</span></a> <span class="n">challenge</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfChallengeDefinition</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">challenge_data</span><span class="p">)</span>
</span><span id="L-205"><a href="#L-205"><span class="linenos">205</span></a> <span class="k">return</span> <span class="n">make_env_with_challenge</span><span class="p">(</span><span class="n">challenge</span><span class="p">)</span>
</span><span id="L-206"><a href="#L-206"><span class="linenos">206</span></a>
</span><span id="L-207"><a href="#L-207"><span class="linenos">207</span></a>
</span><span id="L-208"><a href="#L-208"><span class="linenos">208</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make_env_with_challenge</span><span class="p">(</span>
</span><span id="L-209"><a href="#L-209"><span class="linenos">209</span></a> <span class="n">challenge</span><span class="p">:</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfChallengeDefinition</span><span class="p">,</span>
</span><span id="L-210"><a href="#L-210"><span class="linenos">210</span></a><span class="p">)</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="L-211"><a href="#L-211"><span class="linenos">211</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-212"><a href="#L-212"><span class="linenos">212</span></a><span class="sd"> Create an environment from a VimGolfChallengeDefinition object.</span>
</span><span id="L-213"><a href="#L-213"><span class="linenos">213</span></a>
</span><span id="L-214"><a href="#L-214"><span class="linenos">214</span></a><span class="sd"> This function simply passes the input and output text to make_env_with_text,</span>
</span><span id="L-215"><a href="#L-215"><span class="linenos">215</span></a><span class="sd"> which will create a VimGolfEnv with the given text.</span>
</span><span id="L-216"><a href="#L-216"><span class="linenos">216</span></a>
</span><span id="L-217"><a href="#L-217"><span class="linenos">217</span></a><span class="sd"> Args:</span>
</span><span id="L-218"><a href="#L-218"><span class="linenos">218</span></a><span class="sd"> challenge: VimGolfChallengeDefinition object</span>
</span><span id="L-219"><a href="#L-219"><span class="linenos">219</span></a>
</span><span id="L-220"><a href="#L-220"><span class="linenos">220</span></a><span class="sd"> Returns:</span>
</span><span id="L-221"><a href="#L-221"><span class="linenos">221</span></a><span class="sd"> VimGolfEnv: An environment for the given challenge</span>
</span><span id="L-222"><a href="#L-222"><span class="linenos">222</span></a><span class="sd"> """</span>
</span><span id="L-223"><a href="#L-223"><span class="linenos">223</span></a> <span class="k">return</span> <span class="n">make_env_with_text</span><span class="p">(</span>
</span><span id="L-224"><a href="#L-224"><span class="linenos">224</span></a> <span class="n">input_text</span><span class="o">=</span><span class="n">challenge</span><span class="o">.</span><span class="n">input</span><span class="o">.</span><span class="n">data</span><span class="p">,</span> <span class="n">output_text</span><span class="o">=</span><span class="n">challenge</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">data</span>
</span><span id="L-225"><a href="#L-225"><span class="linenos">225</span></a> <span class="p">)</span>
</span><span id="L-226"><a href="#L-226"><span class="linenos">226</span></a>
</span><span id="L-227"><a href="#L-227"><span class="linenos">227</span></a>
</span><span id="L-228"><a href="#L-228"><span class="linenos">228</span></a><span class="k">def</span><span class="w"> </span><span class="nf">init_cybergod_vimgolf_dataset</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
</span><span id="L-229"><a href="#L-229"><span class="linenos">229</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-230"><a href="#L-230"><span class="linenos">230</span></a><span class="sd"> Initialize the local dataset by downloading it if it does not exist yet.</span>
</span><span id="L-231"><a href="#L-231"><span class="linenos">231</span></a>
</span><span id="L-232"><a href="#L-232"><span class="linenos">232</span></a><span class="sd"> After this function is called, the local dataset should be downloaded and</span>
</span><span id="L-233"><a href="#L-233"><span class="linenos">233</span></a><span class="sd"> ready to use.</span>
</span><span id="L-234"><a href="#L-234"><span class="linenos">234</span></a>
</span><span id="L-235"><a href="#L-235"><span class="linenos">235</span></a><span class="sd"> This function is called by `list_local_challenge_ids` and `make_offline_with_cybergod_dataset`.</span>
</span><span id="L-236"><a href="#L-236"><span class="linenos">236</span></a><span class="sd"> """</span>
</span><span id="L-237"><a href="#L-237"><span class="linenos">237</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">_CYBERGOD_VIMGOLF_GYM_DATASET_DOWNLOADED</span><span class="p">):</span>
</span><span id="L-238"><a href="#L-238"><span class="linenos">238</span></a> <span class="n">download_cybergod_vimgolf_dataset</span><span class="p">()</span>
</span><span id="L-239"><a href="#L-239"><span class="linenos">239</span></a>
</span><span id="L-240"><a href="#L-240"><span class="linenos">240</span></a>
</span><span id="L-241"><a href="#L-241"><span class="linenos">241</span></a><span class="k">def</span><span class="w"> </span><span class="nf">list_local_challenge_ids</span><span class="p">()</span> <span class="o">-></span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
</span><span id="L-242"><a href="#L-242"><span class="linenos">242</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-243"><a href="#L-243"><span class="linenos">243</span></a><span class="sd"> List all challenge ids in the local dataset.</span>
</span><span id="L-244"><a href="#L-244"><span class="linenos">244</span></a>
</span><span id="L-245"><a href="#L-245"><span class="linenos">245</span></a><span class="sd"> This function will download the local dataset if it does not exist yet.</span>
</span><span id="L-246"><a href="#L-246"><span class="linenos">246</span></a>
</span><span id="L-247"><a href="#L-247"><span class="linenos">247</span></a><span class="sd"> Returns:</span>
</span><span id="L-248"><a href="#L-248"><span class="linenos">248</span></a><span class="sd"> list[str]: a list of all challenge ids in the local dataset.</span>
</span><span id="L-249"><a href="#L-249"><span class="linenos">249</span></a><span class="sd"> """</span>
</span><span id="L-250"><a href="#L-250"><span class="linenos">250</span></a>
</span><span id="L-251"><a href="#L-251"><span class="linenos">251</span></a> <span class="n">init_cybergod_vimgolf_dataset</span><span class="p">()</span>
</span><span id="L-252"><a href="#L-252"><span class="linenos">252</span></a> <span class="n">challenges_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-253"><a href="#L-253"><span class="linenos">253</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span>
</span><span id="L-254"><a href="#L-254"><span class="linenos">254</span></a> <span class="s2">"challenges"</span><span class="p">,</span>
</span><span id="L-255"><a href="#L-255"><span class="linenos">255</span></a> <span class="p">)</span>
</span><span id="L-256"><a href="#L-256"><span class="linenos">256</span></a> <span class="n">challenge_ids</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">challenges_dir</span><span class="p">)</span>
</span><span id="L-257"><a href="#L-257"><span class="linenos">257</span></a> <span class="k">return</span> <span class="n">challenge_ids</span>
</span><span id="L-258"><a href="#L-258"><span class="linenos">258</span></a>
</span><span id="L-259"><a href="#L-259"><span class="linenos">259</span></a>
</span><span id="L-260"><a href="#L-260"><span class="linenos">260</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make_offline_with_cybergod_dataset</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="L-261"><a href="#L-261"><span class="linenos">261</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-262"><a href="#L-262"><span class="linenos">262</span></a><span class="sd"> Load a VimGolf challenge from the local dataset and make an environment</span>
</span><span id="L-263"><a href="#L-263"><span class="linenos">263</span></a><span class="sd"> out of it.</span>
</span><span id="L-264"><a href="#L-264"><span class="linenos">264</span></a>
</span><span id="L-265"><a href="#L-265"><span class="linenos">265</span></a><span class="sd"> Given a challenge_id, find the corresponding challenge definition in the</span>
</span><span id="L-266"><a href="#L-266"><span class="linenos">266</span></a><span class="sd"> dataset, parse it into a VimGolfChallengeDefinition object, and create a</span>
</span><span id="L-267"><a href="#L-267"><span class="linenos">267</span></a><span class="sd"> VimGolfEnv out of it.</span>
</span><span id="L-268"><a href="#L-268"><span class="linenos">268</span></a>
</span><span id="L-269"><a href="#L-269"><span class="linenos">269</span></a><span class="sd"> Args:</span>
</span><span id="L-270"><a href="#L-270"><span class="linenos">270</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="L-271"><a href="#L-271"><span class="linenos">271</span></a>
</span><span id="L-272"><a href="#L-272"><span class="linenos">272</span></a><span class="sd"> Returns:</span>
</span><span id="L-273"><a href="#L-273"><span class="linenos">273</span></a><span class="sd"> VimGolfEnv: An environment for the given challenge.</span>
</span><span id="L-274"><a href="#L-274"><span class="linenos">274</span></a><span class="sd"> """</span>
</span><span id="L-275"><a href="#L-275"><span class="linenos">275</span></a> <span class="n">init_cybergod_vimgolf_dataset</span><span class="p">()</span>
</span><span id="L-276"><a href="#L-276"><span class="linenos">276</span></a> <span class="n">challenge</span> <span class="o">=</span> <span class="n">get_local_challenge_definition</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="L-277"><a href="#L-277"><span class="linenos">277</span></a> <span class="k">return</span> <span class="n">make_env_with_challenge</span><span class="p">(</span><span class="n">challenge</span><span class="p">)</span>
</span><span id="L-278"><a href="#L-278"><span class="linenos">278</span></a>
</span><span id="L-279"><a href="#L-279"><span class="linenos">279</span></a>
</span><span id="L-280"><a href="#L-280"><span class="linenos">280</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_metadata</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="L-281"><a href="#L-281"><span class="linenos">281</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-282"><a href="#L-282"><span class="linenos">282</span></a><span class="sd"> Load a VimGolf challenge's metadata from the local dataset.</span>
</span><span id="L-283"><a href="#L-283"><span class="linenos">283</span></a>
</span><span id="L-284"><a href="#L-284"><span class="linenos">284</span></a><span class="sd"> Given a challenge_id, find the corresponding JSON file in the dataset</span>
</span><span id="L-285"><a href="#L-285"><span class="linenos">285</span></a><span class="sd"> and parse it into a VimGolfChallengeMetadata object.</span>
</span><span id="L-286"><a href="#L-286"><span class="linenos">286</span></a>
</span><span id="L-287"><a href="#L-287"><span class="linenos">287</span></a><span class="sd"> Args:</span>
</span><span id="L-288"><a href="#L-288"><span class="linenos">288</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="L-289"><a href="#L-289"><span class="linenos">289</span></a>
</span><span id="L-290"><a href="#L-290"><span class="linenos">290</span></a><span class="sd"> Returns:</span>
</span><span id="L-291"><a href="#L-291"><span class="linenos">291</span></a><span class="sd"> VimGolfChallengeMetadata: Parsed challenge metadata.</span>
</span><span id="L-292"><a href="#L-292"><span class="linenos">292</span></a>
</span><span id="L-293"><a href="#L-293"><span class="linenos">293</span></a><span class="sd"> Raises:</span>
</span><span id="L-294"><a href="#L-294"><span class="linenos">294</span></a><span class="sd"> AssertionError: If the metadata file does not exist.</span>
</span><span id="L-295"><a href="#L-295"><span class="linenos">295</span></a><span class="sd"> """</span>
</span><span id="L-296"><a href="#L-296"><span class="linenos">296</span></a> <span class="n">metadata_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-297"><a href="#L-297"><span class="linenos">297</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span> <span class="s2">"challenges"</span><span class="p">,</span> <span class="n">challenge_id</span><span class="p">,</span> <span class="s2">"metadata.json"</span>
</span><span id="L-298"><a href="#L-298"><span class="linenos">298</span></a> <span class="p">)</span>
</span><span id="L-299"><a href="#L-299"><span class="linenos">299</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">),</span> <span class="p">(</span>
</span><span id="L-300"><a href="#L-300"><span class="linenos">300</span></a> <span class="s2">"Metadata file '</span><span class="si">%s</span><span class="s2">' does not exist"</span> <span class="o">%</span> <span class="n">metadata_file</span>
</span><span id="L-301"><a href="#L-301"><span class="linenos">301</span></a> <span class="p">)</span>
</span><span id="L-302"><a href="#L-302"><span class="linenos">302</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-303"><a href="#L-303"><span class="linenos">303</span></a> <span class="n">metadata</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfChallengeMetadata</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
</span><span id="L-304"><a href="#L-304"><span class="linenos">304</span></a> <span class="k">return</span> <span class="n">metadata</span>
</span><span id="L-305"><a href="#L-305"><span class="linenos">305</span></a>
</span><span id="L-306"><a href="#L-306"><span class="linenos">306</span></a>
</span><span id="L-307"><a href="#L-307"><span class="linenos">307</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_worst_solution</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="L-308"><a href="#L-308"><span class="linenos">308</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-309"><a href="#L-309"><span class="linenos">309</span></a><span class="sd"> Load the worst solution for a challenge from the local dataset.</span>
</span><span id="L-310"><a href="#L-310"><span class="linenos">310</span></a>
</span><span id="L-311"><a href="#L-311"><span class="linenos">311</span></a><span class="sd"> Given a challenge_id, find the corresponding JSON file in the dataset</span>
</span><span id="L-312"><a href="#L-312"><span class="linenos">312</span></a><span class="sd"> and parse it into a VimGolfPublicSolution object.</span>
</span><span id="L-313"><a href="#L-313"><span class="linenos">313</span></a>
</span><span id="L-314"><a href="#L-314"><span class="linenos">314</span></a><span class="sd"> Args:</span>
</span><span id="L-315"><a href="#L-315"><span class="linenos">315</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="L-316"><a href="#L-316"><span class="linenos">316</span></a>
</span><span id="L-317"><a href="#L-317"><span class="linenos">317</span></a><span class="sd"> Returns:</span>
</span><span id="L-318"><a href="#L-318"><span class="linenos">318</span></a><span class="sd"> VimGolfPublicSolution: Parsed worst solution.</span>
</span><span id="L-319"><a href="#L-319"><span class="linenos">319</span></a>
</span><span id="L-320"><a href="#L-320"><span class="linenos">320</span></a><span class="sd"> Raises:</span>
</span><span id="L-321"><a href="#L-321"><span class="linenos">321</span></a><span class="sd"> AssertionError: If the worst solution file does not exist.</span>
</span><span id="L-322"><a href="#L-322"><span class="linenos">322</span></a><span class="sd"> """</span>
</span><span id="L-323"><a href="#L-323"><span class="linenos">323</span></a> <span class="n">metadata_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-324"><a href="#L-324"><span class="linenos">324</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span>
</span><span id="L-325"><a href="#L-325"><span class="linenos">325</span></a> <span class="s2">"challenges"</span><span class="p">,</span>
</span><span id="L-326"><a href="#L-326"><span class="linenos">326</span></a> <span class="n">challenge_id</span><span class="p">,</span>
</span><span id="L-327"><a href="#L-327"><span class="linenos">327</span></a> <span class="s2">"worst_solution.json"</span><span class="p">,</span>
</span><span id="L-328"><a href="#L-328"><span class="linenos">328</span></a> <span class="p">)</span>
</span><span id="L-329"><a href="#L-329"><span class="linenos">329</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">),</span> <span class="p">(</span>
</span><span id="L-330"><a href="#L-330"><span class="linenos">330</span></a> <span class="s2">"Worst solution file '</span><span class="si">%s</span><span class="s2">' does not exist"</span> <span class="o">%</span> <span class="n">metadata_file</span>
</span><span id="L-331"><a href="#L-331"><span class="linenos">331</span></a> <span class="p">)</span>
</span><span id="L-332"><a href="#L-332"><span class="linenos">332</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-333"><a href="#L-333"><span class="linenos">333</span></a> <span class="n">Worst_solution</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfPublicSolution</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
</span><span id="L-334"><a href="#L-334"><span class="linenos">334</span></a> <span class="k">return</span> <span class="n">Worst_solution</span>
</span><span id="L-335"><a href="#L-335"><span class="linenos">335</span></a>
</span><span id="L-336"><a href="#L-336"><span class="linenos">336</span></a>
</span><span id="L-337"><a href="#L-337"><span class="linenos">337</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_worst_solution_header</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="L-338"><a href="#L-338"><span class="linenos">338</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-339"><a href="#L-339"><span class="linenos">339</span></a><span class="sd"> Parse the worst solution's header string from the local dataset.</span>
</span><span id="L-340"><a href="#L-340"><span class="linenos">340</span></a>
</span><span id="L-341"><a href="#L-341"><span class="linenos">341</span></a><span class="sd"> Given a challenge_id, find the corresponding worst solution file in the dataset</span>
</span><span id="L-342"><a href="#L-342"><span class="linenos">342</span></a><span class="sd"> and parse its header string into a VimGolfParsedPublicSolutionHeader object.</span>
</span><span id="L-343"><a href="#L-343"><span class="linenos">343</span></a>
</span><span id="L-344"><a href="#L-344"><span class="linenos">344</span></a><span class="sd"> Args:</span>
</span><span id="L-345"><a href="#L-345"><span class="linenos">345</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="L-346"><a href="#L-346"><span class="linenos">346</span></a>
</span><span id="L-347"><a href="#L-347"><span class="linenos">347</span></a><span class="sd"> Returns:</span>
</span><span id="L-348"><a href="#L-348"><span class="linenos">348</span></a><span class="sd"> VimGolfParsedPublicSolutionHeader: Parsed header string.</span>
</span><span id="L-349"><a href="#L-349"><span class="linenos">349</span></a>
</span><span id="L-350"><a href="#L-350"><span class="linenos">350</span></a><span class="sd"> Raises:</span>
</span><span id="L-351"><a href="#L-351"><span class="linenos">351</span></a><span class="sd"> AssertionError: If the worst solution file does not exist.</span>
</span><span id="L-352"><a href="#L-352"><span class="linenos">352</span></a><span class="sd"> """</span>
</span><span id="L-353"><a href="#L-353"><span class="linenos">353</span></a> <span class="n">solution</span> <span class="o">=</span> <span class="n">get_local_challenge_worst_solution</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="L-354"><a href="#L-354"><span class="linenos">354</span></a> <span class="n">header</span> <span class="o">=</span> <span class="n">solution</span><span class="o">.</span><span class="n">header</span>
</span><span id="L-355"><a href="#L-355"><span class="linenos">355</span></a> <span class="n">ret</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">parse_public_solution_header</span><span class="p">(</span><span class="n">header</span><span class="p">)</span>
</span><span id="L-356"><a href="#L-356"><span class="linenos">356</span></a> <span class="k">return</span> <span class="n">ret</span>
</span><span id="L-357"><a href="#L-357"><span class="linenos">357</span></a>
</span><span id="L-358"><a href="#L-358"><span class="linenos">358</span></a>
</span><span id="L-359"><a href="#L-359"><span class="linenos">359</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_definition</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="L-360"><a href="#L-360"><span class="linenos">360</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-361"><a href="#L-361"><span class="linenos">361</span></a><span class="sd"> Load a VimGolf challenge definition from the local dataset.</span>
</span><span id="L-362"><a href="#L-362"><span class="linenos">362</span></a>
</span><span id="L-363"><a href="#L-363"><span class="linenos">363</span></a><span class="sd"> Given a challenge_id, find the corresponding JSON file in the dataset</span>
</span><span id="L-364"><a href="#L-364"><span class="linenos">364</span></a><span class="sd"> and parse it into a VimGolfChallengeDefinition object.</span>
</span><span id="L-365"><a href="#L-365"><span class="linenos">365</span></a>
</span><span id="L-366"><a href="#L-366"><span class="linenos">366</span></a><span class="sd"> Args:</span>
</span><span id="L-367"><a href="#L-367"><span class="linenos">367</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="L-368"><a href="#L-368"><span class="linenos">368</span></a>
</span><span id="L-369"><a href="#L-369"><span class="linenos">369</span></a><span class="sd"> Returns:</span>
</span><span id="L-370"><a href="#L-370"><span class="linenos">370</span></a><span class="sd"> VimGolfChallengeDefinition: Parsed challenge definition.</span>
</span><span id="L-371"><a href="#L-371"><span class="linenos">371</span></a>
</span><span id="L-372"><a href="#L-372"><span class="linenos">372</span></a><span class="sd"> Raises:</span>
</span><span id="L-373"><a href="#L-373"><span class="linenos">373</span></a><span class="sd"> AssertionError: If the challenge file does not exist.</span>
</span><span id="L-374"><a href="#L-374"><span class="linenos">374</span></a><span class="sd"> """</span>
</span><span id="L-375"><a href="#L-375"><span class="linenos">375</span></a> <span class="n">challenge_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-376"><a href="#L-376"><span class="linenos">376</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span> <span class="s2">"challenges"</span><span class="p">,</span> <span class="n">challenge_id</span><span class="p">,</span> <span class="s2">"challenge.json"</span>
</span><span id="L-377"><a href="#L-377"><span class="linenos">377</span></a> <span class="p">)</span>
</span><span id="L-378"><a href="#L-378"><span class="linenos">378</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">challenge_file</span><span class="p">),</span> <span class="p">(</span>
</span><span id="L-379"><a href="#L-379"><span class="linenos">379</span></a> <span class="s2">"Challenge file '</span><span class="si">%s</span><span class="s2">' does not exist"</span> <span class="o">%</span> <span class="n">challenge_file</span>
</span><span id="L-380"><a href="#L-380"><span class="linenos">380</span></a> <span class="p">)</span>
</span><span id="L-381"><a href="#L-381"><span class="linenos">381</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">challenge_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-382"><a href="#L-382"><span class="linenos">382</span></a> <span class="n">challenge</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfChallengeDefinition</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
</span><span id="L-383"><a href="#L-383"><span class="linenos">383</span></a> <span class="k">return</span> <span class="n">challenge</span>
</span><span id="L-384"><a href="#L-384"><span class="linenos">384</span></a>
</span><span id="L-385"><a href="#L-385"><span class="linenos">385</span></a>
</span><span id="L-386"><a href="#L-386"><span class="linenos">386</span></a><span class="k">def</span><span class="w"> </span><span class="nf">download_cybergod_vimgolf_dataset</span><span class="p">():</span>
</span><span id="L-387"><a href="#L-387"><span class="linenos">387</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-388"><a href="#L-388"><span class="linenos">388</span></a><span class="sd"> Download the CyberGod VimGolf dataset from various sources.</span>
</span><span id="L-389"><a href="#L-389"><span class="linenos">389</span></a>
</span><span id="L-390"><a href="#L-390"><span class="linenos">390</span></a><span class="sd"> This function is called when the dataset is not initialized yet. It downloads the dataset</span>
</span><span id="L-391"><a href="#L-391"><span class="linenos">391</span></a><span class="sd"> from various sources (Kaggle, Hugging Face, GitHub Releases, GitHub Mirror) and extracts it</span>
</span><span id="L-392"><a href="#L-392"><span class="linenos">392</span></a><span class="sd"> to the dataset directory. After the download is finished, it touches the flag file</span>
</span><span id="L-393"><a href="#L-393"><span class="linenos">393</span></a><span class="sd"> _CYBERGOD_VIMGOLF_GYM_DATASET_DOWNLOADED to indicate that the dataset is initialized.</span>
</span><span id="L-394"><a href="#L-394"><span class="linenos">394</span></a>
</span><span id="L-395"><a href="#L-395"><span class="linenos">395</span></a><span class="sd"> If the download fails, it raises an exception and cleans up the dataset directory.</span>
</span><span id="L-396"><a href="#L-396"><span class="linenos">396</span></a>
</span><span id="L-397"><a href="#L-397"><span class="linenos">397</span></a><span class="sd"> :raises DatasetInitError: If the dataset download fails.</span>
</span><span id="L-398"><a href="#L-398"><span class="linenos">398</span></a><span class="sd"> """</span>
</span><span id="L-399"><a href="#L-399"><span class="linenos">399</span></a> <span class="nb">print</span><span class="p">(</span>
</span><span id="L-400"><a href="#L-400"><span class="linenos">400</span></a> <span class="s2">"Initializing CyberGod VimGolf dataset at:"</span><span class="p">,</span> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span>
</span><span id="L-401"><a href="#L-401"><span class="linenos">401</span></a> <span class="p">)</span>
</span><span id="L-402"><a href="#L-402"><span class="linenos">402</span></a> <span class="k">try</span><span class="p">:</span>
</span><span id="L-403"><a href="#L-403"><span class="linenos">403</span></a> <span class="c1"># TODO: add huggingface, hf-mirror.com, github releases and github mirror links</span>
</span><span id="L-404"><a href="#L-404"><span class="linenos">404</span></a> <span class="n">download_urls</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="L-405"><a href="#L-405"><span class="linenos">405</span></a> <span class="s2">"https://www.kaggle.com/api/v1/datasets/download/jessysisca/vimgolf-challenges-and-solutions"</span><span class="p">,</span>
</span><span id="L-406"><a href="#L-406"><span class="linenos">406</span></a> <span class="s2">"https://hf-mirror.com/datasets/James4Ever0/vimgolf_challenges_and_solutions/resolve/main/challenges.zip?download=true"</span><span class="p">,</span>
</span><span id="L-407"><a href="#L-407"><span class="linenos">407</span></a> <span class="s2">"https://huggingface.co/datasets/James4Ever0/vimgolf_challenges_and_solutions/resolve/main/challenges.zip?download=true"</span><span class="p">,</span>
</span><span id="L-408"><a href="#L-408"><span class="linenos">408</span></a> <span class="s2">"https://github.com/James4Ever0/vimgolf-gym/releases/download/dataset-release/challenges.zip"</span><span class="p">,</span>
</span><span id="L-409"><a href="#L-409"><span class="linenos">409</span></a> <span class="s2">"https://bgithub.xyz/James4Ever0/vimgolf-gym/releases/download/dataset-release/challenges.zip"</span><span class="p">,</span>
</span><span id="L-410"><a href="#L-410"><span class="linenos">410</span></a> <span class="p">]</span>
</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a> <span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span> <span class="k">as</span> <span class="n">tempdir</span><span class="p">:</span>
</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a> <span class="n">zip_file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a> <span class="n">tempdir</span><span class="p">,</span> <span class="s2">"vimgolf-challenges-and-solutions.zip"</span>
</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a> <span class="p">)</span>
</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">zip_file_path</span><span class="p">,</span> <span class="s2">"wb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-416"><a href="#L-416"><span class="linenos">416</span></a> <span class="n">content</span> <span class="o">=</span> <span class="kc">None</span>
</span><span id="L-417"><a href="#L-417"><span class="linenos">417</span></a> <span class="k">for</span> <span class="n">url</span> <span class="ow">in</span> <span class="n">download_urls</span><span class="p">:</span>
</span><span id="L-418"><a href="#L-418"><span class="linenos">418</span></a> <span class="k">try</span><span class="p">:</span>
</span><span id="L-419"><a href="#L-419"><span class="linenos">419</span></a> <span class="nb">print</span><span class="p">(</span><span class="s2">"Downloading:"</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
</span><span id="L-420"><a href="#L-420"><span class="linenos">420</span></a> <span class="n">content</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
</span><span id="L-421"><a href="#L-421"><span class="linenos">421</span></a> <span class="n">url</span><span class="p">,</span> <span class="n">allow_redirects</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span>
</span><span id="L-422"><a href="#L-422"><span class="linenos">422</span></a> <span class="p">)</span><span class="o">.</span><span class="n">content</span>
</span><span id="L-423"><a href="#L-423"><span class="linenos">423</span></a> <span class="k">break</span>
</span><span id="L-424"><a href="#L-424"><span class="linenos">424</span></a> <span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">Timeout</span><span class="p">:</span>
</span><span id="L-425"><a href="#L-425"><span class="linenos">425</span></a> <span class="nb">print</span><span class="p">(</span><span class="s2">"Timeout, trying next URL"</span><span class="p">)</span>
</span><span id="L-426"><a href="#L-426"><span class="linenos">426</span></a> <span class="k">if</span> <span class="n">content</span><span class="p">:</span>
</span><span id="L-427"><a href="#L-427"><span class="linenos">427</span></a> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
</span><span id="L-428"><a href="#L-428"><span class="linenos">428</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-429"><a href="#L-429"><span class="linenos">429</span></a> <span class="k">raise</span> <span class="n">DatasetInitError</span><span class="p">(</span><span class="s2">"Failed to download the dataset"</span><span class="p">)</span>
</span><span id="L-430"><a href="#L-430"><span class="linenos">430</span></a> <span class="k">with</span> <span class="n">zipfile</span><span class="o">.</span><span class="n">ZipFile</span><span class="p">(</span><span class="n">zip_file_path</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">zip_ref</span><span class="p">:</span>
</span><span id="L-431"><a href="#L-431"><span class="linenos">431</span></a> <span class="c1"># extract to CYBERGOD_VIMGOLF_GYM_DATASET_DIR</span>
</span><span id="L-432"><a href="#L-432"><span class="linenos">432</span></a> <span class="n">zip_ref</span><span class="o">.</span><span class="n">extractall</span><span class="p">(</span><span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">)</span>
</span><span id="L-433"><a href="#L-433"><span class="linenos">433</span></a> <span class="c1"># after all, touch the flag _CYBERGOD_VIMGOLF_GYM_DATASET_DOWNLOADED</span>
</span><span id="L-434"><a href="#L-434"><span class="linenos">434</span></a> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="n">_CYBERGOD_VIMGOLF_GYM_DATASET_DOWNLOADED</span><span class="p">)</span><span class="o">.</span><span class="n">touch</span><span class="p">()</span>
</span><span id="L-435"><a href="#L-435"><span class="linenos">435</span></a> <span class="k">finally</span><span class="p">:</span>
</span><span id="L-436"><a href="#L-436"><span class="linenos">436</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">_CYBERGOD_VIMGOLF_GYM_DATASET_DOWNLOADED</span><span class="p">):</span>
</span><span id="L-437"><a href="#L-437"><span class="linenos">437</span></a> <span class="c1"># cleanup the dataset basedir, if the dataset is not downloaded successfully</span>
</span><span id="L-438"><a href="#L-438"><span class="linenos">438</span></a> <span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">)</span>
</span><span id="L-439"><a href="#L-439"><span class="linenos">439</span></a>
</span><span id="L-440"><a href="#L-440"><span class="linenos">440</span></a>
</span><span id="L-441"><a href="#L-441"><span class="linenos">441</span></a><span class="k">class</span><span class="w"> </span><span class="nc">VimGolfEnv</span><span class="p">:</span>
</span><span id="L-442"><a href="#L-442"><span class="linenos">442</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
</span><span id="L-443"><a href="#L-443"><span class="linenos">443</span></a> <span class="bp">self</span><span class="p">,</span>
</span><span id="L-444"><a href="#L-444"><span class="linenos">444</span></a> <span class="n">input_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="L-445"><a href="#L-445"><span class="linenos">445</span></a> <span class="n">output_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="L-446"><a href="#L-446"><span class="linenos">446</span></a> <span class="n">width</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">80</span><span class="p">,</span>
</span><span id="L-447"><a href="#L-447"><span class="linenos">447</span></a> <span class="n">height</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">24</span><span class="p">,</span>
</span><span id="L-448"><a href="#L-448"><span class="linenos">448</span></a> <span class="n">init_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
</span><span id="L-449"><a href="#L-449"><span class="linenos">449</span></a> <span class="n">use_docker</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="L-450"><a href="#L-450"><span class="linenos">450</span></a> <span class="n">log_buffer</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="L-451"><a href="#L-451"><span class="linenos">451</span></a> <span class="p">):</span>
</span><span id="L-452"><a href="#L-452"><span class="linenos">452</span></a><span class="w"> </span><span class="sd">"""Initialize the environment with the given input and output files.</span>
</span><span id="L-453"><a href="#L-453"><span class="linenos">453</span></a>
</span><span id="L-454"><a href="#L-454"><span class="linenos">454</span></a><span class="sd"> Args:</span>
</span><span id="L-455"><a href="#L-455"><span class="linenos">455</span></a><span class="sd"> input_file (str): the input file path</span>
</span><span id="L-456"><a href="#L-456"><span class="linenos">456</span></a><span class="sd"> output_file (str): the output file path</span>
</span><span id="L-457"><a href="#L-457"><span class="linenos">457</span></a><span class="sd"> width (int): the width of the terminal</span>
</span><span id="L-458"><a href="#L-458"><span class="linenos">458</span></a><span class="sd"> height (int): the height of the terminal</span>
</span><span id="L-459"><a href="#L-459"><span class="linenos">459</span></a><span class="sd"> use_docker (bool): whether use dockerized executor or local (requiring vim installed)</span>
</span><span id="L-460"><a href="#L-460"><span class="linenos">460</span></a><span class="sd"> log_buffer (bool): whether to log the editor buffer or not</span>
</span><span id="L-461"><a href="#L-461"><span class="linenos">461</span></a><span class="sd"> init_keys (str): initial input keys in Vimgolf solution style</span>
</span><span id="L-462"><a href="#L-462"><span class="linenos">462</span></a><span class="sd"> """</span>
</span><span id="L-463"><a href="#L-463"><span class="linenos">463</span></a>
</span><span id="L-464"><a href="#L-464"><span class="linenos">464</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span> <span class="o">=</span> <span class="n">use_docker</span>
</span><span id="L-465"><a href="#L-465"><span class="linenos">465</span></a><span class="w"> </span><span class="sd">"""whether use dockerized executor or local (requiring vim installed)"""</span>
</span><span id="L-466"><a href="#L-466"><span class="linenos">466</span></a>
</span><span id="L-467"><a href="#L-467"><span class="linenos">467</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span> <span class="o">=</span> <span class="n">input_file</span>
</span><span id="L-468"><a href="#L-468"><span class="linenos">468</span></a><span class="w"> </span><span class="sd">"""the input file path"""</span>
</span><span id="L-469"><a href="#L-469"><span class="linenos">469</span></a>
</span><span id="L-470"><a href="#L-470"><span class="linenos">470</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span> <span class="o">=</span> <span class="n">output_file</span>
</span><span id="L-471"><a href="#L-471"><span class="linenos">471</span></a><span class="w"> </span><span class="sd">"""the output file path"""</span>
</span><span id="L-472"><a href="#L-472"><span class="linenos">472</span></a>
</span><span id="L-473"><a href="#L-473"><span class="linenos">473</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span> <span class="o">=</span> <span class="n">log_buffer</span>
</span><span id="L-474"><a href="#L-474"><span class="linenos">474</span></a><span class="w"> </span><span class="sd">"""whether to log the editor buffer or not"""</span>
</span><span id="L-475"><a href="#L-475"><span class="linenos">475</span></a>
</span><span id="L-476"><a href="#L-476"><span class="linenos">476</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span> <span class="o">=</span> <span class="n">init_keys</span>
</span><span id="L-477"><a href="#L-477"><span class="linenos">477</span></a><span class="w"> </span><span class="sd">"""initial input keys in Vimgolf solution style"""</span>
</span><span id="L-478"><a href="#L-478"><span class="linenos">478</span></a>
</span><span id="L-479"><a href="#L-479"><span class="linenos">479</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span>
</span><span id="L-480"><a href="#L-480"><span class="linenos">480</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span>
</span><span id="L-481"><a href="#L-481"><span class="linenos">481</span></a> <span class="p">),</span> <span class="sa">f</span><span class="s2">"Input file </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="si">}</span><span class="s2"> does not exist."</span>
</span><span id="L-482"><a href="#L-482"><span class="linenos">482</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span>
</span><span id="L-483"><a href="#L-483"><span class="linenos">483</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span>
</span><span id="L-484"><a href="#L-484"><span class="linenos">484</span></a> <span class="p">),</span> <span class="sa">f</span><span class="s2">"Output file </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="si">}</span><span class="s2"> does not exist."</span>
</span><span id="L-485"><a href="#L-485"><span class="linenos">485</span></a>
</span><span id="L-486"><a href="#L-486"><span class="linenos">486</span></a> <span class="c1"># TODO: run a modified version of vimgolf local python script writing progress to a jsonl file, which embeds in this script, for easy state inspection and data collection (we can create a temporary directory for cleanup)</span>
</span><span id="L-487"><a href="#L-487"><span class="linenos">487</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span>
</span><span id="L-488"><a href="#L-488"><span class="linenos">488</span></a><span class="w"> </span><span class="sd">"""the log directory, where tempfiles stored"""</span>
</span><span id="L-489"><a href="#L-489"><span class="linenos">489</span></a>
</span><span id="L-490"><a href="#L-490"><span class="linenos">490</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"vimgolf.log"</span><span class="p">)</span>
</span><span id="L-491"><a href="#L-491"><span class="linenos">491</span></a><span class="w"> </span><span class="sd">"""the log file path, used to retrieve progress info of the vimgolf process"""</span>
</span><span id="L-492"><a href="#L-492"><span class="linenos">492</span></a>
</span><span id="L-493"><a href="#L-493"><span class="linenos">493</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="L-494"><a href="#L-494"><span class="linenos">494</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"vimgolf_editor_buffer"</span>
</span><span id="L-495"><a href="#L-495"><span class="linenos">495</span></a> <span class="p">)</span>
</span><span id="L-496"><a href="#L-496"><span class="linenos">496</span></a><span class="w"> </span><span class="sd">"""the editor buffer, used to track granual progress"""</span>
</span><span id="L-497"><a href="#L-497"><span class="linenos">497</span></a>
</span><span id="L-498"><a href="#L-498"><span class="linenos">498</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
</span><span id="L-499"><a href="#L-499"><span class="linenos">499</span></a>
</span><span id="L-500"><a href="#L-500"><span class="linenos">500</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">:</span>
</span><span id="L-501"><a href="#L-501"><span class="linenos">501</span></a> <span class="n">mountpoint</span> <span class="o">=</span> <span class="s2">"/vimgolf_gym_workdir"</span>
</span><span id="L-502"><a href="#L-502"><span class="linenos">502</span></a> <span class="n">docker_output_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"out"</span><span class="p">)</span>
</span><span id="L-503"><a href="#L-503"><span class="linenos">503</span></a> <span class="n">docker_input_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"in"</span><span class="p">)</span>
</span><span id="L-504"><a href="#L-504"><span class="linenos">504</span></a> <span class="n">docker_buffer_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"vimgolf_editor_buffer"</span><span class="p">)</span>
</span><span id="L-505"><a href="#L-505"><span class="linenos">505</span></a> <span class="n">docker_log_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"vimgolf.log"</span><span class="p">)</span>
</span><span id="L-506"><a href="#L-506"><span class="linenos">506</span></a> <span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"in"</span><span class="p">))</span>
</span><span id="L-507"><a href="#L-507"><span class="linenos">507</span></a> <span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"out"</span><span class="p">))</span>
</span><span id="L-508"><a href="#L-508"><span class="linenos">508</span></a> <span class="n">extra_docker_run_params</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="L-509"><a href="#L-509"><span class="linenos">509</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="L-510"><a href="#L-510"><span class="linenos">510</span></a> <span class="n">_prepare_cybergod_vimrc_with_buffer_file</span><span class="p">(</span><span class="n">docker_buffer_file</span><span class="p">)</span>
</span><span id="L-511"><a href="#L-511"><span class="linenos">511</span></a> <span class="n">extra_docker_run_params</span> <span class="o">+=</span> <span class="p">[</span>
</span><span id="L-512"><a href="#L-512"><span class="linenos">512</span></a> <span class="s2">"-v"</span><span class="p">,</span>
</span><span id="L-513"><a href="#L-513"><span class="linenos">513</span></a> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">:ro"</span>
</span><span id="L-514"><a href="#L-514"><span class="linenos">514</span></a> <span class="o">%</span> <span class="p">(</span>
</span><span id="L-515"><a href="#L-515"><span class="linenos">515</span></a> <span class="n">_CYBERGOD_VIMGOLF_VIMRC_FILEPATH</span><span class="p">,</span>
</span><span id="L-516"><a href="#L-516"><span class="linenos">516</span></a> <span class="s2">"/usr/local/lib/python3.10/dist-packages/vimgolf/vimgolf.vimrc"</span><span class="p">,</span>
</span><span id="L-517"><a href="#L-517"><span class="linenos">517</span></a> <span class="p">),</span>
</span><span id="L-518"><a href="#L-518"><span class="linenos">518</span></a> <span class="p">]</span>
</span><span id="L-519"><a href="#L-519"><span class="linenos">519</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="L-520"><a href="#L-520"><span class="linenos">520</span></a> <span class="s2">"docker"</span><span class="p">,</span>
</span><span id="L-521"><a href="#L-521"><span class="linenos">521</span></a> <span class="s2">"run"</span><span class="p">,</span>
</span><span id="L-522"><a href="#L-522"><span class="linenos">522</span></a> <span class="s2">"--rm"</span><span class="p">,</span>
</span><span id="L-523"><a href="#L-523"><span class="linenos">523</span></a> <span class="s2">"-it"</span><span class="p">,</span>
</span><span id="L-524"><a href="#L-524"><span class="linenos">524</span></a> <span class="s2">"--name"</span><span class="p">,</span>
</span><span id="L-525"><a href="#L-525"><span class="linenos">525</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span><span class="p">,</span>
</span><span id="L-526"><a href="#L-526"><span class="linenos">526</span></a> <span class="s2">"-v"</span><span class="p">,</span>
</span><span id="L-527"><a href="#L-527"><span class="linenos">527</span></a> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">mountpoint</span><span class="p">),</span>
</span><span id="L-528"><a href="#L-528"><span class="linenos">528</span></a> <span class="o">*</span><span class="n">extra_docker_run_params</span><span class="p">,</span>
</span><span id="L-529"><a href="#L-529"><span class="linenos">529</span></a> <span class="s2">"--entrypoint"</span><span class="p">,</span>
</span><span id="L-530"><a href="#L-530"><span class="linenos">530</span></a> <span class="s2">"python3"</span><span class="p">,</span>
</span><span id="L-531"><a href="#L-531"><span class="linenos">531</span></a> <span class="s2">"agile4im/cybergod_vimgolf_gym"</span><span class="p">,</span>
</span><span id="L-532"><a href="#L-532"><span class="linenos">532</span></a> <span class="s2">"-m"</span><span class="p">,</span>
</span><span id="L-533"><a href="#L-533"><span class="linenos">533</span></a> <span class="s2">"vimgolf_gym.vimgolf"</span><span class="p">,</span>
</span><span id="L-534"><a href="#L-534"><span class="linenos">534</span></a> <span class="s2">"--input_file"</span><span class="p">,</span>
</span><span id="L-535"><a href="#L-535"><span class="linenos">535</span></a> <span class="n">docker_input_file</span><span class="p">,</span>
</span><span id="L-536"><a href="#L-536"><span class="linenos">536</span></a> <span class="s2">"--output_file"</span><span class="p">,</span>
</span><span id="L-537"><a href="#L-537"><span class="linenos">537</span></a> <span class="n">docker_output_file</span><span class="p">,</span>
</span><span id="L-538"><a href="#L-538"><span class="linenos">538</span></a> <span class="s2">"--log_file"</span><span class="p">,</span>
</span><span id="L-539"><a href="#L-539"><span class="linenos">539</span></a> <span class="n">docker_log_file</span><span class="p">,</span>
</span><span id="L-540"><a href="#L-540"><span class="linenos">540</span></a> <span class="p">]</span>
</span><span id="L-541"><a href="#L-541"><span class="linenos">541</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">:</span>
</span><span id="L-542"><a href="#L-542"><span class="linenos">542</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--init_keys"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">]</span>
</span><span id="L-543"><a href="#L-543"><span class="linenos">543</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-544"><a href="#L-544"><span class="linenos">544</span></a> <span class="n">extra_flags</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="L-545"><a href="#L-545"><span class="linenos">545</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="L-546"><a href="#L-546"><span class="linenos">546</span></a> <span class="n">extra_flags</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--buffer_file"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">]</span>
</span><span id="L-547"><a href="#L-547"><span class="linenos">547</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">:</span>
</span><span id="L-548"><a href="#L-548"><span class="linenos">548</span></a> <span class="n">extra_flags</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--init_keys"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">]</span>
</span><span id="L-549"><a href="#L-549"><span class="linenos">549</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="L-550"><a href="#L-550"><span class="linenos">550</span></a> <span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="p">,</span>
</span><span id="L-551"><a href="#L-551"><span class="linenos">551</span></a> <span class="s2">"-m"</span><span class="p">,</span>
</span><span id="L-552"><a href="#L-552"><span class="linenos">552</span></a> <span class="s2">"vimgolf_gym.vimgolf"</span><span class="p">,</span>
</span><span id="L-553"><a href="#L-553"><span class="linenos">553</span></a> <span class="s2">"--input_file"</span><span class="p">,</span>
</span><span id="L-554"><a href="#L-554"><span class="linenos">554</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span>
</span><span id="L-555"><a href="#L-555"><span class="linenos">555</span></a> <span class="s2">"--output_file"</span><span class="p">,</span>
</span><span id="L-556"><a href="#L-556"><span class="linenos">556</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span>
</span><span id="L-557"><a href="#L-557"><span class="linenos">557</span></a> <span class="s2">"--log_file"</span><span class="p">,</span>
</span><span id="L-558"><a href="#L-558"><span class="linenos">558</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">,</span>
</span><span id="L-559"><a href="#L-559"><span class="linenos">559</span></a> <span class="o">*</span><span class="n">extra_flags</span><span class="p">,</span>
</span><span id="L-560"><a href="#L-560"><span class="linenos">560</span></a> <span class="p">]</span>
</span><span id="L-561"><a href="#L-561"><span class="linenos">561</span></a>
</span><span id="L-562"><a href="#L-562"><span class="linenos">562</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="L-563"><a href="#L-563"><span class="linenos">563</span></a>
</span><span id="L-564"><a href="#L-564"><span class="linenos">564</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</span><span id="L-565"><a href="#L-565"><span class="linenos">565</span></a><span class="w"> </span><span class="sd">"""the command passed to underlying terminal executor"""</span>
</span><span id="L-566"><a href="#L-566"><span class="linenos">566</span></a>
</span><span id="L-567"><a href="#L-567"><span class="linenos">567</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="n">width</span>
</span><span id="L-568"><a href="#L-568"><span class="linenos">568</span></a><span class="w"> </span><span class="sd">"""terminal width"""</span>
</span><span id="L-569"><a href="#L-569"><span class="linenos">569</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">height</span> <span class="o">=</span> <span class="n">height</span>
</span><span id="L-570"><a href="#L-570"><span class="linenos">570</span></a><span class="w"> </span><span class="sd">"""terminal height"""</span>
</span><span id="L-571"><a href="#L-571"><span class="linenos">571</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">create_executor_and_log_watcher</span><span class="p">()</span>
</span><span id="L-572"><a href="#L-572"><span class="linenos">572</span></a>
</span><span id="L-573"><a href="#L-573"><span class="linenos">573</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="p">:</span> <span class="n">terminal_executor</span><span class="o">.</span><span class="n">TerminalExecutor</span>
</span><span id="L-574"><a href="#L-574"><span class="linenos">574</span></a><span class="w"> </span><span class="sd">"""terminal executor for running vimgolf process"""</span>
</span><span id="L-575"><a href="#L-575"><span class="linenos">575</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="p">:</span> <span class="n">log_parser</span><span class="o">.</span><span class="n">VimGolfLogWatcher</span>
</span><span id="L-576"><a href="#L-576"><span class="linenos">576</span></a><span class="w"> </span><span class="sd">"""log watcher for tracking vimgolf log output"""</span>
</span><span id="L-577"><a href="#L-577"><span class="linenos">577</span></a> <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">cleanup</span><span class="p">)</span>
</span><span id="L-578"><a href="#L-578"><span class="linenos">578</span></a> <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_kill_docker_container</span><span class="p">)</span>
</span><span id="L-579"><a href="#L-579"><span class="linenos">579</span></a>
</span><span id="L-580"><a href="#L-580"><span class="linenos">580</span></a> <span class="nd">@property</span>
</span><span id="L-581"><a href="#L-581"><span class="linenos">581</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">buffer</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]:</span>
</span><span id="L-582"><a href="#L-582"><span class="linenos">582</span></a><span class="w"> </span><span class="sd">"""The editor buffer"""</span>
</span><span id="L-583"><a href="#L-583"><span class="linenos">583</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="L-584"><a href="#L-584"><span class="linenos">584</span></a> <span class="k">return</span> <span class="kc">None</span>
</span><span id="L-585"><a href="#L-585"><span class="linenos">585</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-586"><a href="#L-586"><span class="linenos">586</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">):</span>
</span><span id="L-587"><a href="#L-587"><span class="linenos">587</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-588"><a href="#L-588"><span class="linenos">588</span></a> <span class="k">return</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="L-589"><a href="#L-589"><span class="linenos">589</span></a>
</span><span id="L-590"><a href="#L-590"><span class="linenos">590</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">act</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="L-591"><a href="#L-591"><span class="linenos">591</span></a><span class="w"> </span><span class="sd">"""Take an action</span>
</span><span id="L-592"><a href="#L-592"><span class="linenos">592</span></a>
</span><span id="L-593"><a href="#L-593"><span class="linenos">593</span></a><span class="sd"> Args:</span>
</span><span id="L-594"><a href="#L-594"><span class="linenos">594</span></a><span class="sd"> action (str): the action to take</span>
</span><span id="L-595"><a href="#L-595"><span class="linenos">595</span></a><span class="sd"> """</span>
</span><span id="L-596"><a href="#L-596"><span class="linenos">596</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
</span><span id="L-597"><a href="#L-597"><span class="linenos">597</span></a>
</span><span id="L-598"><a href="#L-598"><span class="linenos">598</span></a> <span class="nd">@property</span>
</span><span id="L-599"><a href="#L-599"><span class="linenos">599</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">success</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-600"><a href="#L-600"><span class="linenos">600</span></a><span class="w"> </span><span class="sd">"""Check if the vimgolf challenge has been solved successfully"""</span>
</span><span id="L-601"><a href="#L-601"><span class="linenos">601</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">success</span>
</span><span id="L-602"><a href="#L-602"><span class="linenos">602</span></a>
</span><span id="L-603"><a href="#L-603"><span class="linenos">603</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_best_success_result</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-604"><a href="#L-604"><span class="linenos">604</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-605"><a href="#L-605"><span class="linenos">605</span></a><span class="sd"> Return the best success result in the log watcher.</span>
</span><span id="L-606"><a href="#L-606"><span class="linenos">606</span></a>
</span><span id="L-607"><a href="#L-607"><span class="linenos">607</span></a><span class="sd"> Returns:</span>
</span><span id="L-608"><a href="#L-608"><span class="linenos">608</span></a><span class="sd"> Optional[VimGolfEnvResult]: The best success result.</span>
</span><span id="L-609"><a href="#L-609"><span class="linenos">609</span></a><span class="sd"> """</span>
</span><span id="L-610"><a href="#L-610"><span class="linenos">610</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">get_best_success_result</span><span class="p">()</span>
</span><span id="L-611"><a href="#L-611"><span class="linenos">611</span></a>
</span><span id="L-612"><a href="#L-612"><span class="linenos">612</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_last_success_result</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-613"><a href="#L-613"><span class="linenos">613</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-614"><a href="#L-614"><span class="linenos">614</span></a><span class="sd"> Return the last success result in the log watcher.</span>
</span><span id="L-615"><a href="#L-615"><span class="linenos">615</span></a>
</span><span id="L-616"><a href="#L-616"><span class="linenos">616</span></a><span class="sd"> Returns:</span>
</span><span id="L-617"><a href="#L-617"><span class="linenos">617</span></a><span class="sd"> Optional[VimGolfEnvResult]: The last success result</span>
</span><span id="L-618"><a href="#L-618"><span class="linenos">618</span></a><span class="sd"> """</span>
</span><span id="L-619"><a href="#L-619"><span class="linenos">619</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">get_last_success_result</span><span class="p">()</span>
</span><span id="L-620"><a href="#L-620"><span class="linenos">620</span></a>
</span><span id="L-621"><a href="#L-621"><span class="linenos">621</span></a> <span class="nd">@property</span>
</span><span id="L-622"><a href="#L-622"><span class="linenos">622</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">results</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-623"><a href="#L-623"><span class="linenos">623</span></a><span class="w"> </span><span class="sd">"""The results of the vimgolf challenge environment</span>
</span><span id="L-624"><a href="#L-624"><span class="linenos">624</span></a>
</span><span id="L-625"><a href="#L-625"><span class="linenos">625</span></a><span class="sd"> Returns:</span>
</span><span id="L-626"><a href="#L-626"><span class="linenos">626</span></a><span class="sd"> list[VimGolfEnvResult]: The results of the vimgolf challenge environment</span>
</span><span id="L-627"><a href="#L-627"><span class="linenos">627</span></a><span class="sd"> """</span>
</span><span id="L-628"><a href="#L-628"><span class="linenos">628</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">results</span>
</span><span id="L-629"><a href="#L-629"><span class="linenos">629</span></a>
</span><span id="L-630"><a href="#L-630"><span class="linenos">630</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-631"><a href="#L-631"><span class="linenos">631</span></a> <span class="k">return</span> <span class="bp">self</span>
</span><span id="L-632"><a href="#L-632"><span class="linenos">632</span></a>
</span><span id="L-633"><a href="#L-633"><span class="linenos">633</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">tb</span><span class="p">):</span>
</span><span id="L-634"><a href="#L-634"><span class="linenos">634</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="L-635"><a href="#L-635"><span class="linenos">635</span></a>
</span><span id="L-636"><a href="#L-636"><span class="linenos">636</span></a> <span class="nd">@property</span>
</span><span id="L-637"><a href="#L-637"><span class="linenos">637</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">success_results</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-638"><a href="#L-638"><span class="linenos">638</span></a><span class="w"> </span><span class="sd">"""The success results of the vimgolf challenge environment</span>
</span><span id="L-639"><a href="#L-639"><span class="linenos">639</span></a>
</span><span id="L-640"><a href="#L-640"><span class="linenos">640</span></a><span class="sd"> Returns:</span>
</span><span id="L-641"><a href="#L-641"><span class="linenos">641</span></a><span class="sd"> list[VimGolfEnvResult]: The success results of the vimgolf challenge environment</span>
</span><span id="L-642"><a href="#L-642"><span class="linenos">642</span></a><span class="sd"> """</span>
</span><span id="L-643"><a href="#L-643"><span class="linenos">643</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">success_results</span>
</span><span id="L-644"><a href="#L-644"><span class="linenos">644</span></a>
</span><span id="L-645"><a href="#L-645"><span class="linenos">645</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">create_executor_and_log_watcher</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-646"><a href="#L-646"><span class="linenos">646</span></a><span class="w"> </span><span class="sd">"""Create the executor and log watcher"""</span>
</span><span id="L-647"><a href="#L-647"><span class="linenos">647</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span> <span class="o">=</span> <span class="n">terminal_executor</span><span class="o">.</span><span class="n">TerminalExecutor</span><span class="p">(</span>
</span><span id="L-648"><a href="#L-648"><span class="linenos">648</span></a> <span class="n">command</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">height</span>
</span><span id="L-649"><a href="#L-649"><span class="linenos">649</span></a> <span class="p">)</span>
</span><span id="L-650"><a href="#L-650"><span class="linenos">650</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"log_watcher"</span><span class="p">):</span>
</span><span id="L-651"><a href="#L-651"><span class="linenos">651</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span> <span class="o">=</span> <span class="n">log_parser</span><span class="o">.</span><span class="n">VimGolfLogWatcher</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">)</span>
</span><span id="L-652"><a href="#L-652"><span class="linenos">652</span></a> <span class="c1"># shall we wait the executor be ready</span>
</span><span id="L-653"><a href="#L-653"><span class="linenos">653</span></a> <span class="c1"># we wait for the 'play(...)' indicator to appear in the log file.</span>
</span><span id="L-654"><a href="#L-654"><span class="linenos">654</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
</span><span id="L-655"><a href="#L-655"><span class="linenos">655</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">):</span>
</span><span id="L-656"><a href="#L-656"><span class="linenos">656</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-657"><a href="#L-657"><span class="linenos">657</span></a> <span class="n">log_content</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="L-658"><a href="#L-658"><span class="linenos">658</span></a> <span class="k">if</span> <span class="s2">"play(...)"</span> <span class="ow">in</span> <span class="n">log_content</span><span class="p">:</span>
</span><span id="L-659"><a href="#L-659"><span class="linenos">659</span></a> <span class="k">break</span>
</span><span id="L-660"><a href="#L-660"><span class="linenos">660</span></a> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.5</span><span class="p">)</span>
</span><span id="L-661"><a href="#L-661"><span class="linenos">661</span></a>
</span><span id="L-662"><a href="#L-662"><span class="linenos">662</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-663"><a href="#L-663"><span class="linenos">663</span></a><span class="w"> </span><span class="sd">"""Reset the environment"""</span>
</span><span id="L-664"><a href="#L-664"><span class="linenos">664</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="L-665"><a href="#L-665"><span class="linenos">665</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="L-666"><a href="#L-666"><span class="linenos">666</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">create_executor_and_log_watcher</span><span class="p">()</span>
</span><span id="L-667"><a href="#L-667"><span class="linenos">667</span></a>
</span><span id="L-668"><a href="#L-668"><span class="linenos">668</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-669"><a href="#L-669"><span class="linenos">669</span></a><span class="w"> </span><span class="sd">"""Render the environment"""</span>
</span><span id="L-670"><a href="#L-670"><span class="linenos">670</span></a> <span class="n">screenshot</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">screenshot</span><span class="p">()</span>
</span><span id="L-671"><a href="#L-671"><span class="linenos">671</span></a> <span class="c1"># display the screenshot</span>
</span><span id="L-672"><a href="#L-672"><span class="linenos">672</span></a> <span class="n">screenshot</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</span><span id="L-673"><a href="#L-673"><span class="linenos">673</span></a>
</span><span id="L-674"><a href="#L-674"><span class="linenos">674</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">screenshot</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-675"><a href="#L-675"><span class="linenos">675</span></a><span class="w"> </span><span class="sd">"""Take a screenshot of the environment</span>
</span><span id="L-676"><a href="#L-676"><span class="linenos">676</span></a>
</span><span id="L-677"><a href="#L-677"><span class="linenos">677</span></a><span class="sd"> Returns:</span>
</span><span id="L-678"><a href="#L-678"><span class="linenos">678</span></a><span class="sd"> PIL.Image.Image: The screenshot</span>
</span><span id="L-679"><a href="#L-679"><span class="linenos">679</span></a><span class="sd"> """</span>
</span><span id="L-680"><a href="#L-680"><span class="linenos">680</span></a> <span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span> <span class="k">as</span> <span class="n">tmpdir</span><span class="p">:</span>
</span><span id="L-681"><a href="#L-681"><span class="linenos">681</span></a> <span class="n">png_tmpfile_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmpdir</span><span class="p">,</span> <span class="s2">"screenshot.png"</span><span class="p">)</span>
</span><span id="L-682"><a href="#L-682"><span class="linenos">682</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">screenshot</span><span class="p">(</span><span class="n">png_tmpfile_path</span><span class="p">)</span>
</span><span id="L-683"><a href="#L-683"><span class="linenos">683</span></a> <span class="n">image</span> <span class="o">=</span> <span class="n">PIL</span><span class="o">.</span><span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">png_tmpfile_path</span><span class="p">)</span>
</span><span id="L-684"><a href="#L-684"><span class="linenos">684</span></a> <span class="k">return</span> <span class="n">image</span>
</span><span id="L-685"><a href="#L-685"><span class="linenos">685</span></a>
</span><span id="L-686"><a href="#L-686"><span class="linenos">686</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">_kill_docker_container</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-687"><a href="#L-687"><span class="linenos">687</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">:</span>
</span><span id="L-688"><a href="#L-688"><span class="linenos">688</span></a> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span>
</span><span id="L-689"><a href="#L-689"><span class="linenos">689</span></a> <span class="p">[</span><span class="s2">"docker"</span><span class="p">,</span> <span class="s2">"kill"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span><span class="p">],</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span>
</span><span id="L-690"><a href="#L-690"><span class="linenos">690</span></a> <span class="p">)</span>
</span><span id="L-691"><a href="#L-691"><span class="linenos">691</span></a>
</span><span id="L-692"><a href="#L-692"><span class="linenos">692</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">verify_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keys</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="L-693"><a href="#L-693"><span class="linenos">693</span></a><span class="w"> </span><span class="sd">"""Verify a solution by its keys</span>
</span><span id="L-694"><a href="#L-694"><span class="linenos">694</span></a>
</span><span id="L-695"><a href="#L-695"><span class="linenos">695</span></a><span class="sd"> Args:</span>
</span><span id="L-696"><a href="#L-696"><span class="linenos">696</span></a><span class="sd"> keys (str): the keys to verify, in Vimgolf style</span>
</span><span id="L-697"><a href="#L-697"><span class="linenos">697</span></a><span class="sd"> """</span>
</span><span id="L-698"><a href="#L-698"><span class="linenos">698</span></a> <span class="k">assert</span> <span class="n">keys</span><span class="p">,</span> <span class="s2">"Keys cannot be empty"</span>
</span><span id="L-699"><a href="#L-699"><span class="linenos">699</span></a> <span class="k">with</span> <span class="n">VimGolfEnv</span><span class="p">(</span>
</span><span id="L-700"><a href="#L-700"><span class="linenos">700</span></a> <span class="n">input_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span>
</span><span id="L-701"><a href="#L-701"><span class="linenos">701</span></a> <span class="n">output_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span>
</span><span id="L-702"><a href="#L-702"><span class="linenos">702</span></a> <span class="n">init_keys</span><span class="o">=</span><span class="n">keys</span><span class="p">,</span>
</span><span id="L-703"><a href="#L-703"><span class="linenos">703</span></a> <span class="n">use_docker</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">,</span>
</span><span id="L-704"><a href="#L-704"><span class="linenos">704</span></a> <span class="n">log_buffer</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
</span><span id="L-705"><a href="#L-705"><span class="linenos">705</span></a> <span class="p">)</span> <span class="k">as</span> <span class="n">env</span><span class="p">:</span>
</span><span id="L-706"><a href="#L-706"><span class="linenos">706</span></a> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">):</span>
</span><span id="L-707"><a href="#L-707"><span class="linenos">707</span></a> <span class="n">success</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">success</span>
</span><span id="L-708"><a href="#L-708"><span class="linenos">708</span></a> <span class="k">if</span> <span class="n">success</span><span class="p">:</span>
</span><span id="L-709"><a href="#L-709"><span class="linenos">709</span></a> <span class="k">break</span>
</span><span id="L-710"><a href="#L-710"><span class="linenos">710</span></a> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</span><span id="L-711"><a href="#L-711"><span class="linenos">711</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">success</span><span class="p">:</span>
</span><span id="L-712"><a href="#L-712"><span class="linenos">712</span></a> <span class="n">buffer</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">buffer</span>
</span><span id="L-713"><a href="#L-713"><span class="linenos">713</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-714"><a href="#L-714"><span class="linenos">714</span></a> <span class="n">expected_output</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="L-715"><a href="#L-715"><span class="linenos">715</span></a> <span class="n">success</span> <span class="o">=</span> <span class="n">buffer</span> <span class="o">==</span> <span class="n">expected_output</span>
</span><span id="L-716"><a href="#L-716"><span class="linenos">716</span></a> <span class="k">return</span> <span class="n">success</span>
</span><span id="L-717"><a href="#L-717"><span class="linenos">717</span></a>
</span><span id="L-718"><a href="#L-718"><span class="linenos">718</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-719"><a href="#L-719"><span class="linenos">719</span></a><span class="w"> </span><span class="sd">"""Close the environment"""</span>
</span><span id="L-720"><a href="#L-720"><span class="linenos">720</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span><span class="p">:</span>
</span><span id="L-721"><a href="#L-721"><span class="linenos">721</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">True</span>
</span><span id="L-722"><a href="#L-722"><span class="linenos">722</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="L-723"><a href="#L-723"><span class="linenos">723</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_kill_docker_container</span><span class="p">()</span>
</span><span id="L-724"><a href="#L-724"><span class="linenos">724</span></a> <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span>
</span><span id="L-725"><a href="#L-725"><span class="linenos">725</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">):</span>
</span><span id="L-726"><a href="#L-726"><span class="linenos">726</span></a> <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">)</span>
</span><span id="L-727"><a href="#L-727"><span class="linenos">727</span></a> <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"executor"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
</span><span id="L-728"><a href="#L-728"><span class="linenos">728</span></a>
</span><span id="L-729"><a href="#L-729"><span class="linenos">729</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">calculate_relative_inverse_score</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">score</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">worst_score</span><span class="p">:</span><span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span><span id="L-730"><a href="#L-730"><span class="linenos">730</span></a><span class="w"> </span><span class="sd">"""Calculate the relative inverse score of the given score</span>
</span><span id="L-731"><a href="#L-731"><span class="linenos">731</span></a><span class="sd"> </span>
</span><span id="L-732"><a href="#L-732"><span class="linenos">732</span></a><span class="sd"> Args:</span>
</span><span id="L-733"><a href="#L-733"><span class="linenos">733</span></a><span class="sd"> score (int): The score to calculate the relative inverse score of.</span>
</span><span id="L-734"><a href="#L-734"><span class="linenos">734</span></a><span class="sd"> worst_score (int, optional): The worst score to use. Defaults to None.</span>
</span><span id="L-735"><a href="#L-735"><span class="linenos">735</span></a>
</span><span id="L-736"><a href="#L-736"><span class="linenos">736</span></a><span class="sd"> Returns:</span>
</span><span id="L-737"><a href="#L-737"><span class="linenos">737</span></a><span class="sd"> float: The relative inverse score.</span>
</span><span id="L-738"><a href="#L-738"><span class="linenos">738</span></a><span class="sd"> """</span>
</span><span id="L-739"><a href="#L-739"><span class="linenos">739</span></a> <span class="k">assert</span> <span class="n">score</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"Score must be non-negative"</span>
</span><span id="L-740"><a href="#L-740"><span class="linenos">740</span></a> <span class="k">if</span> <span class="n">worst_score</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="L-741"><a href="#L-741"><span class="linenos">741</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="L-742"><a href="#L-742"><span class="linenos">742</span></a> <span class="n">worst_score</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span> <span class="o">+</span> <span class="mi">10</span>
</span><span id="L-743"><a href="#L-743"><span class="linenos">743</span></a> <span class="n">ret</span> <span class="o">=</span> <span class="n">worst_score</span> <span class="o">/</span> <span class="n">score</span>
</span><span id="L-744"><a href="#L-744"><span class="linenos">744</span></a> <span class="k">return</span> <span class="n">ret</span>
</span></pre></div>
</section>
<section id="make">
<input id="make-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">make</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">env_name</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">custom_challenge</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n"><a href="dataclasses.html#VimGolfCustomChallenge">vimgolf_gym.dataclasses.VimGolfCustomChallenge</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">use_docker</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>,</span><span class="param"> <span class="n">log_buffer</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span></span><span class="return-annotation">) -> <span class="n"><a href="#VimGolfEnv">VimGolfEnv</a></span>:</span></span>
<label class="view-source-button" for="make-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#make"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="make-73"><a href="#make-73"><span class="linenos"> 73</span></a><span class="k">def</span><span class="w"> </span><span class="nf">make</span><span class="p">(</span>
</span><span id="make-74"><a href="#make-74"><span class="linenos"> 74</span></a> <span class="n">env_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="make-75"><a href="#make-75"><span class="linenos"> 75</span></a> <span class="n">custom_challenge</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfCustomChallenge</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
</span><span id="make-76"><a href="#make-76"><span class="linenos"> 76</span></a> <span class="n">use_docker</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="make-77"><a href="#make-77"><span class="linenos"> 77</span></a> <span class="n">log_buffer</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="make-78"><a href="#make-78"><span class="linenos"> 78</span></a><span class="p">)</span> <span class="o">-></span> <span class="s2">"VimGolfEnv"</span><span class="p">:</span>
</span><span id="make-79"><a href="#make-79"><span class="linenos"> 79</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="make-80"><a href="#make-80"><span class="linenos"> 80</span></a><span class="sd"> Create a VimGolf environment.</span>
</span><span id="make-81"><a href="#make-81"><span class="linenos"> 81</span></a>
</span><span id="make-82"><a href="#make-82"><span class="linenos"> 82</span></a><span class="sd"> The env_name can be one of the following:</span>
</span><span id="make-83"><a href="#make-83"><span class="linenos"> 83</span></a><span class="sd"> - `vimgolf-test`: A simple test environment.</span>
</span><span id="make-84"><a href="#make-84"><span class="linenos"> 84</span></a><span class="sd"> - `vimgolf-local-<challenge_id>`: A local environment for a specific challenge.</span>
</span><span id="make-85"><a href="#make-85"><span class="linenos"> 85</span></a><span class="sd"> - `vimgolf-online-<challenge_id>`: An online environment for a specific challenge.</span>
</span><span id="make-86"><a href="#make-86"><span class="linenos"> 86</span></a><span class="sd"> - `vimgolf-custom`: A custom environment. The `custom_challenge` parameter will be used.</span>
</span><span id="make-87"><a href="#make-87"><span class="linenos"> 87</span></a>
</span><span id="make-88"><a href="#make-88"><span class="linenos"> 88</span></a><span class="sd"> Args:</span>
</span><span id="make-89"><a href="#make-89"><span class="linenos"> 89</span></a><span class="sd"> env_name (str): The name of the environment to create.</span>
</span><span id="make-90"><a href="#make-90"><span class="linenos"> 90</span></a><span class="sd"> use_docker (bool, optional): Whether to use a dockerized executor. Defaults to False.</span>
</span><span id="make-91"><a href="#make-91"><span class="linenos"> 91</span></a><span class="sd"> log_buffer (bool, optional): Whether to log the editor buffer or not. Defaults to False.</span>
</span><span id="make-92"><a href="#make-92"><span class="linenos"> 92</span></a><span class="sd"> custom_challenge (Optional[VimGolfCustomChallenge], optional): The custom challenge to use. Defaults to None.</span>
</span><span id="make-93"><a href="#make-93"><span class="linenos"> 93</span></a>
</span><span id="make-94"><a href="#make-94"><span class="linenos"> 94</span></a><span class="sd"> Raises:</span>
</span><span id="make-95"><a href="#make-95"><span class="linenos"> 95</span></a><span class="sd"> NotImplementedError: If the environment name is not recognized.</span>
</span><span id="make-96"><a href="#make-96"><span class="linenos"> 96</span></a>
</span><span id="make-97"><a href="#make-97"><span class="linenos"> 97</span></a><span class="sd"> Returns:</span>
</span><span id="make-98"><a href="#make-98"><span class="linenos"> 98</span></a><span class="sd"> VimGolfEnv: The created environment</span>
</span><span id="make-99"><a href="#make-99"><span class="linenos"> 99</span></a><span class="sd"> """</span>
</span><span id="make-100"><a href="#make-100"><span class="linenos">100</span></a> <span class="k">if</span> <span class="n">use_docker</span><span class="p">:</span>
</span><span id="make-101"><a href="#make-101"><span class="linenos">101</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_USE_DOCKER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span>
</span><span id="make-102"><a href="#make-102"><span class="linenos">102</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="make-103"><a href="#make-103"><span class="linenos">103</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_USE_DOCKER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"0"</span>
</span><span id="make-104"><a href="#make-104"><span class="linenos">104</span></a>
</span><span id="make-105"><a href="#make-105"><span class="linenos">105</span></a> <span class="k">if</span> <span class="n">log_buffer</span><span class="p">:</span>
</span><span id="make-106"><a href="#make-106"><span class="linenos">106</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_LOG_BUFFER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span>
</span><span id="make-107"><a href="#make-107"><span class="linenos">107</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="make-108"><a href="#make-108"><span class="linenos">108</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"VIMGOLF_GYM_LOG_BUFFER"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"0"</span>
</span><span id="make-109"><a href="#make-109"><span class="linenos">109</span></a>
</span><span id="make-110"><a href="#make-110"><span class="linenos">110</span></a> <span class="k">if</span> <span class="n">env_name</span> <span class="o">==</span> <span class="s2">"vimgolf-test"</span><span class="p">:</span>
</span><span id="make-111"><a href="#make-111"><span class="linenos">111</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_test</span><span class="p">()</span>
</span><span id="make-112"><a href="#make-112"><span class="linenos">112</span></a> <span class="k">elif</span> <span class="n">env_name</span> <span class="o">==</span> <span class="s2">"vimgolf-custom"</span><span class="p">:</span>
</span><span id="make-113"><a href="#make-113"><span class="linenos">113</span></a> <span class="k">assert</span> <span class="p">(</span>
</span><span id="make-114"><a href="#make-114"><span class="linenos">114</span></a> <span class="n">custom_challenge</span>
</span><span id="make-115"><a href="#make-115"><span class="linenos">115</span></a> <span class="p">),</span> <span class="s2">"custom_challenge must be provided for vimgolf-custom environment"</span>
</span><span id="make-116"><a href="#make-116"><span class="linenos">116</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_env_with_text</span><span class="p">(</span>
</span><span id="make-117"><a href="#make-117"><span class="linenos">117</span></a> <span class="nb">input</span><span class="o">=</span><span class="n">custom_challenge</span><span class="o">.</span><span class="n">input</span><span class="p">,</span> <span class="n">output</span><span class="o">=</span><span class="n">custom_challenge</span><span class="o">.</span><span class="n">output</span>
</span><span id="make-118"><a href="#make-118"><span class="linenos">118</span></a> <span class="p">)</span>
</span><span id="make-119"><a href="#make-119"><span class="linenos">119</span></a> <span class="k">elif</span> <span class="n">env_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"vimgolf-local-"</span><span class="p">):</span>
</span><span id="make-120"><a href="#make-120"><span class="linenos">120</span></a> <span class="n">challenge_id</span> <span class="o">=</span> <span class="n">env_name</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"vimgolf-local-"</span><span class="p">)</span> <span class="p">:]</span>
</span><span id="make-121"><a href="#make-121"><span class="linenos">121</span></a> <span class="n">assert_challenge_id_length</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="make-122"><a href="#make-122"><span class="linenos">122</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_offline_with_cybergod_dataset</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="make-123"><a href="#make-123"><span class="linenos">123</span></a> <span class="k">elif</span> <span class="n">env_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"vimgolf-online-"</span><span class="p">):</span>
</span><span id="make-124"><a href="#make-124"><span class="linenos">124</span></a> <span class="n">challenge_id</span> <span class="o">=</span> <span class="n">env_name</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"vimgolf-online-"</span><span class="p">)</span> <span class="p">:]</span>
</span><span id="make-125"><a href="#make-125"><span class="linenos">125</span></a> <span class="n">assert_challenge_id_length</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="make-126"><a href="#make-126"><span class="linenos">126</span></a> <span class="n">env</span> <span class="o">=</span> <span class="n">make_online</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="make-127"><a href="#make-127"><span class="linenos">127</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="make-128"><a href="#make-128"><span class="linenos">128</span></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span>
</span><span id="make-129"><a href="#make-129"><span class="linenos">129</span></a> <span class="k">return</span> <span class="n">env</span>
</span></pre></div>
<div class="docstring"><p>Create a VimGolf environment.</p>
<p>The env_name can be one of the following:</p>
<ul>
<li><code>vimgolf-test</code>: A simple test environment.</li>
<li><code>vimgolf-local-<challenge_id></code>: A local environment for a specific challenge.</li>
<li><code>vimgolf-online-<challenge_id></code>: An online environment for a specific challenge.</li>
<li><code>vimgolf-custom</code>: A custom environment. The <code>custom_challenge</code> parameter will be used.</li>
</ul>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>env_name (str):</strong> The name of the environment to create.</li>
<li><strong>use_docker (bool, optional):</strong> Whether to use a dockerized executor. Defaults to False.</li>
<li><strong>log_buffer (bool, optional):</strong> Whether to log the editor buffer or not. Defaults to False.</li>
<li><strong>custom_challenge (Optional[VimGolfCustomChallenge], optional):</strong> The custom challenge to use. Defaults to None.</li>
</ul>
<h6 id="raises">Raises:</h6>
<ul>
<li><strong>NotImplementedError:</strong> If the environment name is not recognized.</li>
</ul>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>VimGolfEnv: The created environment</p>
</blockquote>
</div>
</section>
<section id="list_local_challenge_ids">
<input id="list_local_challenge_ids-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">list_local_challenge_ids</span><span class="signature pdoc-code condensed">(<span class="return-annotation">) -> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>:</span></span>
<label class="view-source-button" for="list_local_challenge_ids-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#list_local_challenge_ids"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="list_local_challenge_ids-242"><a href="#list_local_challenge_ids-242"><span class="linenos">242</span></a><span class="k">def</span><span class="w"> </span><span class="nf">list_local_challenge_ids</span><span class="p">()</span> <span class="o">-></span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
</span><span id="list_local_challenge_ids-243"><a href="#list_local_challenge_ids-243"><span class="linenos">243</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="list_local_challenge_ids-244"><a href="#list_local_challenge_ids-244"><span class="linenos">244</span></a><span class="sd"> List all challenge ids in the local dataset.</span>
</span><span id="list_local_challenge_ids-245"><a href="#list_local_challenge_ids-245"><span class="linenos">245</span></a>
</span><span id="list_local_challenge_ids-246"><a href="#list_local_challenge_ids-246"><span class="linenos">246</span></a><span class="sd"> This function will download the local dataset if it does not exist yet.</span>
</span><span id="list_local_challenge_ids-247"><a href="#list_local_challenge_ids-247"><span class="linenos">247</span></a>
</span><span id="list_local_challenge_ids-248"><a href="#list_local_challenge_ids-248"><span class="linenos">248</span></a><span class="sd"> Returns:</span>
</span><span id="list_local_challenge_ids-249"><a href="#list_local_challenge_ids-249"><span class="linenos">249</span></a><span class="sd"> list[str]: a list of all challenge ids in the local dataset.</span>
</span><span id="list_local_challenge_ids-250"><a href="#list_local_challenge_ids-250"><span class="linenos">250</span></a><span class="sd"> """</span>
</span><span id="list_local_challenge_ids-251"><a href="#list_local_challenge_ids-251"><span class="linenos">251</span></a>
</span><span id="list_local_challenge_ids-252"><a href="#list_local_challenge_ids-252"><span class="linenos">252</span></a> <span class="n">init_cybergod_vimgolf_dataset</span><span class="p">()</span>
</span><span id="list_local_challenge_ids-253"><a href="#list_local_challenge_ids-253"><span class="linenos">253</span></a> <span class="n">challenges_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="list_local_challenge_ids-254"><a href="#list_local_challenge_ids-254"><span class="linenos">254</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span>
</span><span id="list_local_challenge_ids-255"><a href="#list_local_challenge_ids-255"><span class="linenos">255</span></a> <span class="s2">"challenges"</span><span class="p">,</span>
</span><span id="list_local_challenge_ids-256"><a href="#list_local_challenge_ids-256"><span class="linenos">256</span></a> <span class="p">)</span>
</span><span id="list_local_challenge_ids-257"><a href="#list_local_challenge_ids-257"><span class="linenos">257</span></a> <span class="n">challenge_ids</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">challenges_dir</span><span class="p">)</span>
</span><span id="list_local_challenge_ids-258"><a href="#list_local_challenge_ids-258"><span class="linenos">258</span></a> <span class="k">return</span> <span class="n">challenge_ids</span>
</span></pre></div>
<div class="docstring"><p>List all challenge ids in the local dataset.</p>
<p>This function will download the local dataset if it does not exist yet.</p>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>list[str]: a list of all challenge ids in the local dataset.</p>
</blockquote>
</div>
</section>
<section id="get_local_challenge_definition">
<input id="get_local_challenge_definition-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">get_local_challenge_definition</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="get_local_challenge_definition-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#get_local_challenge_definition"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="get_local_challenge_definition-360"><a href="#get_local_challenge_definition-360"><span class="linenos">360</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_definition</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="get_local_challenge_definition-361"><a href="#get_local_challenge_definition-361"><span class="linenos">361</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="get_local_challenge_definition-362"><a href="#get_local_challenge_definition-362"><span class="linenos">362</span></a><span class="sd"> Load a VimGolf challenge definition from the local dataset.</span>
</span><span id="get_local_challenge_definition-363"><a href="#get_local_challenge_definition-363"><span class="linenos">363</span></a>
</span><span id="get_local_challenge_definition-364"><a href="#get_local_challenge_definition-364"><span class="linenos">364</span></a><span class="sd"> Given a challenge_id, find the corresponding JSON file in the dataset</span>
</span><span id="get_local_challenge_definition-365"><a href="#get_local_challenge_definition-365"><span class="linenos">365</span></a><span class="sd"> and parse it into a VimGolfChallengeDefinition object.</span>
</span><span id="get_local_challenge_definition-366"><a href="#get_local_challenge_definition-366"><span class="linenos">366</span></a>
</span><span id="get_local_challenge_definition-367"><a href="#get_local_challenge_definition-367"><span class="linenos">367</span></a><span class="sd"> Args:</span>
</span><span id="get_local_challenge_definition-368"><a href="#get_local_challenge_definition-368"><span class="linenos">368</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="get_local_challenge_definition-369"><a href="#get_local_challenge_definition-369"><span class="linenos">369</span></a>
</span><span id="get_local_challenge_definition-370"><a href="#get_local_challenge_definition-370"><span class="linenos">370</span></a><span class="sd"> Returns:</span>
</span><span id="get_local_challenge_definition-371"><a href="#get_local_challenge_definition-371"><span class="linenos">371</span></a><span class="sd"> VimGolfChallengeDefinition: Parsed challenge definition.</span>
</span><span id="get_local_challenge_definition-372"><a href="#get_local_challenge_definition-372"><span class="linenos">372</span></a>
</span><span id="get_local_challenge_definition-373"><a href="#get_local_challenge_definition-373"><span class="linenos">373</span></a><span class="sd"> Raises:</span>
</span><span id="get_local_challenge_definition-374"><a href="#get_local_challenge_definition-374"><span class="linenos">374</span></a><span class="sd"> AssertionError: If the challenge file does not exist.</span>
</span><span id="get_local_challenge_definition-375"><a href="#get_local_challenge_definition-375"><span class="linenos">375</span></a><span class="sd"> """</span>
</span><span id="get_local_challenge_definition-376"><a href="#get_local_challenge_definition-376"><span class="linenos">376</span></a> <span class="n">challenge_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="get_local_challenge_definition-377"><a href="#get_local_challenge_definition-377"><span class="linenos">377</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span> <span class="s2">"challenges"</span><span class="p">,</span> <span class="n">challenge_id</span><span class="p">,</span> <span class="s2">"challenge.json"</span>
</span><span id="get_local_challenge_definition-378"><a href="#get_local_challenge_definition-378"><span class="linenos">378</span></a> <span class="p">)</span>
</span><span id="get_local_challenge_definition-379"><a href="#get_local_challenge_definition-379"><span class="linenos">379</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">challenge_file</span><span class="p">),</span> <span class="p">(</span>
</span><span id="get_local_challenge_definition-380"><a href="#get_local_challenge_definition-380"><span class="linenos">380</span></a> <span class="s2">"Challenge file '</span><span class="si">%s</span><span class="s2">' does not exist"</span> <span class="o">%</span> <span class="n">challenge_file</span>
</span><span id="get_local_challenge_definition-381"><a href="#get_local_challenge_definition-381"><span class="linenos">381</span></a> <span class="p">)</span>
</span><span id="get_local_challenge_definition-382"><a href="#get_local_challenge_definition-382"><span class="linenos">382</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">challenge_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="get_local_challenge_definition-383"><a href="#get_local_challenge_definition-383"><span class="linenos">383</span></a> <span class="n">challenge</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfChallengeDefinition</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
</span><span id="get_local_challenge_definition-384"><a href="#get_local_challenge_definition-384"><span class="linenos">384</span></a> <span class="k">return</span> <span class="n">challenge</span>
</span></pre></div>
<div class="docstring"><p>Load a VimGolf challenge definition from the local dataset.</p>
<p>Given a challenge_id, find the corresponding JSON file in the dataset
and parse it into a VimGolfChallengeDefinition object.</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>challenge_id (str):</strong> Unique identifier for the challenge.</li>
</ul>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>VimGolfChallengeDefinition: Parsed challenge definition.</p>
</blockquote>
<h6 id="raises">Raises:</h6>
<ul>
<li><strong>AssertionError:</strong> If the challenge file does not exist.</li>
</ul>
</div>
</section>
<section id="get_local_challenge_metadata">
<input id="get_local_challenge_metadata-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">get_local_challenge_metadata</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="get_local_challenge_metadata-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#get_local_challenge_metadata"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="get_local_challenge_metadata-281"><a href="#get_local_challenge_metadata-281"><span class="linenos">281</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_metadata</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="get_local_challenge_metadata-282"><a href="#get_local_challenge_metadata-282"><span class="linenos">282</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="get_local_challenge_metadata-283"><a href="#get_local_challenge_metadata-283"><span class="linenos">283</span></a><span class="sd"> Load a VimGolf challenge's metadata from the local dataset.</span>
</span><span id="get_local_challenge_metadata-284"><a href="#get_local_challenge_metadata-284"><span class="linenos">284</span></a>
</span><span id="get_local_challenge_metadata-285"><a href="#get_local_challenge_metadata-285"><span class="linenos">285</span></a><span class="sd"> Given a challenge_id, find the corresponding JSON file in the dataset</span>
</span><span id="get_local_challenge_metadata-286"><a href="#get_local_challenge_metadata-286"><span class="linenos">286</span></a><span class="sd"> and parse it into a VimGolfChallengeMetadata object.</span>
</span><span id="get_local_challenge_metadata-287"><a href="#get_local_challenge_metadata-287"><span class="linenos">287</span></a>
</span><span id="get_local_challenge_metadata-288"><a href="#get_local_challenge_metadata-288"><span class="linenos">288</span></a><span class="sd"> Args:</span>
</span><span id="get_local_challenge_metadata-289"><a href="#get_local_challenge_metadata-289"><span class="linenos">289</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="get_local_challenge_metadata-290"><a href="#get_local_challenge_metadata-290"><span class="linenos">290</span></a>
</span><span id="get_local_challenge_metadata-291"><a href="#get_local_challenge_metadata-291"><span class="linenos">291</span></a><span class="sd"> Returns:</span>
</span><span id="get_local_challenge_metadata-292"><a href="#get_local_challenge_metadata-292"><span class="linenos">292</span></a><span class="sd"> VimGolfChallengeMetadata: Parsed challenge metadata.</span>
</span><span id="get_local_challenge_metadata-293"><a href="#get_local_challenge_metadata-293"><span class="linenos">293</span></a>
</span><span id="get_local_challenge_metadata-294"><a href="#get_local_challenge_metadata-294"><span class="linenos">294</span></a><span class="sd"> Raises:</span>
</span><span id="get_local_challenge_metadata-295"><a href="#get_local_challenge_metadata-295"><span class="linenos">295</span></a><span class="sd"> AssertionError: If the metadata file does not exist.</span>
</span><span id="get_local_challenge_metadata-296"><a href="#get_local_challenge_metadata-296"><span class="linenos">296</span></a><span class="sd"> """</span>
</span><span id="get_local_challenge_metadata-297"><a href="#get_local_challenge_metadata-297"><span class="linenos">297</span></a> <span class="n">metadata_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="get_local_challenge_metadata-298"><a href="#get_local_challenge_metadata-298"><span class="linenos">298</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span> <span class="s2">"challenges"</span><span class="p">,</span> <span class="n">challenge_id</span><span class="p">,</span> <span class="s2">"metadata.json"</span>
</span><span id="get_local_challenge_metadata-299"><a href="#get_local_challenge_metadata-299"><span class="linenos">299</span></a> <span class="p">)</span>
</span><span id="get_local_challenge_metadata-300"><a href="#get_local_challenge_metadata-300"><span class="linenos">300</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">),</span> <span class="p">(</span>
</span><span id="get_local_challenge_metadata-301"><a href="#get_local_challenge_metadata-301"><span class="linenos">301</span></a> <span class="s2">"Metadata file '</span><span class="si">%s</span><span class="s2">' does not exist"</span> <span class="o">%</span> <span class="n">metadata_file</span>
</span><span id="get_local_challenge_metadata-302"><a href="#get_local_challenge_metadata-302"><span class="linenos">302</span></a> <span class="p">)</span>
</span><span id="get_local_challenge_metadata-303"><a href="#get_local_challenge_metadata-303"><span class="linenos">303</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="get_local_challenge_metadata-304"><a href="#get_local_challenge_metadata-304"><span class="linenos">304</span></a> <span class="n">metadata</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfChallengeMetadata</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
</span><span id="get_local_challenge_metadata-305"><a href="#get_local_challenge_metadata-305"><span class="linenos">305</span></a> <span class="k">return</span> <span class="n">metadata</span>
</span></pre></div>
<div class="docstring"><p>Load a VimGolf challenge's metadata from the local dataset.</p>
<p>Given a challenge_id, find the corresponding JSON file in the dataset
and parse it into a VimGolfChallengeMetadata object.</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>challenge_id (str):</strong> Unique identifier for the challenge.</li>
</ul>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>VimGolfChallengeMetadata: Parsed challenge metadata.</p>
</blockquote>
<h6 id="raises">Raises:</h6>
<ul>
<li><strong>AssertionError:</strong> If the metadata file does not exist.</li>
</ul>
</div>
</section>
<section id="get_local_challenge_worst_solution">
<input id="get_local_challenge_worst_solution-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">get_local_challenge_worst_solution</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="get_local_challenge_worst_solution-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#get_local_challenge_worst_solution"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="get_local_challenge_worst_solution-308"><a href="#get_local_challenge_worst_solution-308"><span class="linenos">308</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_worst_solution</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="get_local_challenge_worst_solution-309"><a href="#get_local_challenge_worst_solution-309"><span class="linenos">309</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="get_local_challenge_worst_solution-310"><a href="#get_local_challenge_worst_solution-310"><span class="linenos">310</span></a><span class="sd"> Load the worst solution for a challenge from the local dataset.</span>
</span><span id="get_local_challenge_worst_solution-311"><a href="#get_local_challenge_worst_solution-311"><span class="linenos">311</span></a>
</span><span id="get_local_challenge_worst_solution-312"><a href="#get_local_challenge_worst_solution-312"><span class="linenos">312</span></a><span class="sd"> Given a challenge_id, find the corresponding JSON file in the dataset</span>
</span><span id="get_local_challenge_worst_solution-313"><a href="#get_local_challenge_worst_solution-313"><span class="linenos">313</span></a><span class="sd"> and parse it into a VimGolfPublicSolution object.</span>
</span><span id="get_local_challenge_worst_solution-314"><a href="#get_local_challenge_worst_solution-314"><span class="linenos">314</span></a>
</span><span id="get_local_challenge_worst_solution-315"><a href="#get_local_challenge_worst_solution-315"><span class="linenos">315</span></a><span class="sd"> Args:</span>
</span><span id="get_local_challenge_worst_solution-316"><a href="#get_local_challenge_worst_solution-316"><span class="linenos">316</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="get_local_challenge_worst_solution-317"><a href="#get_local_challenge_worst_solution-317"><span class="linenos">317</span></a>
</span><span id="get_local_challenge_worst_solution-318"><a href="#get_local_challenge_worst_solution-318"><span class="linenos">318</span></a><span class="sd"> Returns:</span>
</span><span id="get_local_challenge_worst_solution-319"><a href="#get_local_challenge_worst_solution-319"><span class="linenos">319</span></a><span class="sd"> VimGolfPublicSolution: Parsed worst solution.</span>
</span><span id="get_local_challenge_worst_solution-320"><a href="#get_local_challenge_worst_solution-320"><span class="linenos">320</span></a>
</span><span id="get_local_challenge_worst_solution-321"><a href="#get_local_challenge_worst_solution-321"><span class="linenos">321</span></a><span class="sd"> Raises:</span>
</span><span id="get_local_challenge_worst_solution-322"><a href="#get_local_challenge_worst_solution-322"><span class="linenos">322</span></a><span class="sd"> AssertionError: If the worst solution file does not exist.</span>
</span><span id="get_local_challenge_worst_solution-323"><a href="#get_local_challenge_worst_solution-323"><span class="linenos">323</span></a><span class="sd"> """</span>
</span><span id="get_local_challenge_worst_solution-324"><a href="#get_local_challenge_worst_solution-324"><span class="linenos">324</span></a> <span class="n">metadata_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="get_local_challenge_worst_solution-325"><a href="#get_local_challenge_worst_solution-325"><span class="linenos">325</span></a> <span class="n">_CYBERGOD_VIMGOLF_DATASET_BASEDIR</span><span class="p">,</span>
</span><span id="get_local_challenge_worst_solution-326"><a href="#get_local_challenge_worst_solution-326"><span class="linenos">326</span></a> <span class="s2">"challenges"</span><span class="p">,</span>
</span><span id="get_local_challenge_worst_solution-327"><a href="#get_local_challenge_worst_solution-327"><span class="linenos">327</span></a> <span class="n">challenge_id</span><span class="p">,</span>
</span><span id="get_local_challenge_worst_solution-328"><a href="#get_local_challenge_worst_solution-328"><span class="linenos">328</span></a> <span class="s2">"worst_solution.json"</span><span class="p">,</span>
</span><span id="get_local_challenge_worst_solution-329"><a href="#get_local_challenge_worst_solution-329"><span class="linenos">329</span></a> <span class="p">)</span>
</span><span id="get_local_challenge_worst_solution-330"><a href="#get_local_challenge_worst_solution-330"><span class="linenos">330</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">),</span> <span class="p">(</span>
</span><span id="get_local_challenge_worst_solution-331"><a href="#get_local_challenge_worst_solution-331"><span class="linenos">331</span></a> <span class="s2">"Worst solution file '</span><span class="si">%s</span><span class="s2">' does not exist"</span> <span class="o">%</span> <span class="n">metadata_file</span>
</span><span id="get_local_challenge_worst_solution-332"><a href="#get_local_challenge_worst_solution-332"><span class="linenos">332</span></a> <span class="p">)</span>
</span><span id="get_local_challenge_worst_solution-333"><a href="#get_local_challenge_worst_solution-333"><span class="linenos">333</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">metadata_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="get_local_challenge_worst_solution-334"><a href="#get_local_challenge_worst_solution-334"><span class="linenos">334</span></a> <span class="n">Worst_solution</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">VimGolfPublicSolution</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
</span><span id="get_local_challenge_worst_solution-335"><a href="#get_local_challenge_worst_solution-335"><span class="linenos">335</span></a> <span class="k">return</span> <span class="n">Worst_solution</span>
</span></pre></div>
<div class="docstring"><p>Load the worst solution for a challenge from the local dataset.</p>
<p>Given a challenge_id, find the corresponding JSON file in the dataset
and parse it into a VimGolfPublicSolution object.</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>challenge_id (str):</strong> Unique identifier for the challenge.</li>
</ul>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>VimGolfPublicSolution: Parsed worst solution.</p>
</blockquote>
<h6 id="raises">Raises:</h6>
<ul>
<li><strong>AssertionError:</strong> If the worst solution file does not exist.</li>
</ul>
</div>
</section>
<section id="get_local_challenge_worst_solution_header">
<input id="get_local_challenge_worst_solution_header-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">get_local_challenge_worst_solution_header</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="get_local_challenge_worst_solution_header-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#get_local_challenge_worst_solution_header"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="get_local_challenge_worst_solution_header-338"><a href="#get_local_challenge_worst_solution_header-338"><span class="linenos">338</span></a><span class="k">def</span><span class="w"> </span><span class="nf">get_local_challenge_worst_solution_header</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="get_local_challenge_worst_solution_header-339"><a href="#get_local_challenge_worst_solution_header-339"><span class="linenos">339</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="get_local_challenge_worst_solution_header-340"><a href="#get_local_challenge_worst_solution_header-340"><span class="linenos">340</span></a><span class="sd"> Parse the worst solution's header string from the local dataset.</span>
</span><span id="get_local_challenge_worst_solution_header-341"><a href="#get_local_challenge_worst_solution_header-341"><span class="linenos">341</span></a>
</span><span id="get_local_challenge_worst_solution_header-342"><a href="#get_local_challenge_worst_solution_header-342"><span class="linenos">342</span></a><span class="sd"> Given a challenge_id, find the corresponding worst solution file in the dataset</span>
</span><span id="get_local_challenge_worst_solution_header-343"><a href="#get_local_challenge_worst_solution_header-343"><span class="linenos">343</span></a><span class="sd"> and parse its header string into a VimGolfParsedPublicSolutionHeader object.</span>
</span><span id="get_local_challenge_worst_solution_header-344"><a href="#get_local_challenge_worst_solution_header-344"><span class="linenos">344</span></a>
</span><span id="get_local_challenge_worst_solution_header-345"><a href="#get_local_challenge_worst_solution_header-345"><span class="linenos">345</span></a><span class="sd"> Args:</span>
</span><span id="get_local_challenge_worst_solution_header-346"><a href="#get_local_challenge_worst_solution_header-346"><span class="linenos">346</span></a><span class="sd"> challenge_id (str): Unique identifier for the challenge.</span>
</span><span id="get_local_challenge_worst_solution_header-347"><a href="#get_local_challenge_worst_solution_header-347"><span class="linenos">347</span></a>
</span><span id="get_local_challenge_worst_solution_header-348"><a href="#get_local_challenge_worst_solution_header-348"><span class="linenos">348</span></a><span class="sd"> Returns:</span>
</span><span id="get_local_challenge_worst_solution_header-349"><a href="#get_local_challenge_worst_solution_header-349"><span class="linenos">349</span></a><span class="sd"> VimGolfParsedPublicSolutionHeader: Parsed header string.</span>
</span><span id="get_local_challenge_worst_solution_header-350"><a href="#get_local_challenge_worst_solution_header-350"><span class="linenos">350</span></a>
</span><span id="get_local_challenge_worst_solution_header-351"><a href="#get_local_challenge_worst_solution_header-351"><span class="linenos">351</span></a><span class="sd"> Raises:</span>
</span><span id="get_local_challenge_worst_solution_header-352"><a href="#get_local_challenge_worst_solution_header-352"><span class="linenos">352</span></a><span class="sd"> AssertionError: If the worst solution file does not exist.</span>
</span><span id="get_local_challenge_worst_solution_header-353"><a href="#get_local_challenge_worst_solution_header-353"><span class="linenos">353</span></a><span class="sd"> """</span>
</span><span id="get_local_challenge_worst_solution_header-354"><a href="#get_local_challenge_worst_solution_header-354"><span class="linenos">354</span></a> <span class="n">solution</span> <span class="o">=</span> <span class="n">get_local_challenge_worst_solution</span><span class="p">(</span><span class="n">challenge_id</span><span class="p">)</span>
</span><span id="get_local_challenge_worst_solution_header-355"><a href="#get_local_challenge_worst_solution_header-355"><span class="linenos">355</span></a> <span class="n">header</span> <span class="o">=</span> <span class="n">solution</span><span class="o">.</span><span class="n">header</span>
</span><span id="get_local_challenge_worst_solution_header-356"><a href="#get_local_challenge_worst_solution_header-356"><span class="linenos">356</span></a> <span class="n">ret</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">parse_public_solution_header</span><span class="p">(</span><span class="n">header</span><span class="p">)</span>
</span><span id="get_local_challenge_worst_solution_header-357"><a href="#get_local_challenge_worst_solution_header-357"><span class="linenos">357</span></a> <span class="k">return</span> <span class="n">ret</span>
</span></pre></div>
<div class="docstring"><p>Parse the worst solution's header string from the local dataset.</p>
<p>Given a challenge_id, find the corresponding worst solution file in the dataset
and parse its header string into a VimGolfParsedPublicSolutionHeader object.</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>challenge_id (str):</strong> Unique identifier for the challenge.</li>
</ul>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>VimGolfParsedPublicSolutionHeader: Parsed header string.</p>
</blockquote>
<h6 id="raises">Raises:</h6>
<ul>
<li><strong>AssertionError:</strong> If the worst solution file does not exist.</li>
</ul>
</div>
</section>
<section id="VimGolfEnv">
<input id="VimGolfEnv-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr class">
<span class="def">class</span>
<span class="name">VimGolfEnv</span>:
<label class="view-source-button" for="VimGolfEnv-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv-442"><a href="#VimGolfEnv-442"><span class="linenos">442</span></a><span class="k">class</span><span class="w"> </span><span class="nc">VimGolfEnv</span><span class="p">:</span>
</span><span id="VimGolfEnv-443"><a href="#VimGolfEnv-443"><span class="linenos">443</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
</span><span id="VimGolfEnv-444"><a href="#VimGolfEnv-444"><span class="linenos">444</span></a> <span class="bp">self</span><span class="p">,</span>
</span><span id="VimGolfEnv-445"><a href="#VimGolfEnv-445"><span class="linenos">445</span></a> <span class="n">input_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="VimGolfEnv-446"><a href="#VimGolfEnv-446"><span class="linenos">446</span></a> <span class="n">output_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="VimGolfEnv-447"><a href="#VimGolfEnv-447"><span class="linenos">447</span></a> <span class="n">width</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">80</span><span class="p">,</span>
</span><span id="VimGolfEnv-448"><a href="#VimGolfEnv-448"><span class="linenos">448</span></a> <span class="n">height</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">24</span><span class="p">,</span>
</span><span id="VimGolfEnv-449"><a href="#VimGolfEnv-449"><span class="linenos">449</span></a> <span class="n">init_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
</span><span id="VimGolfEnv-450"><a href="#VimGolfEnv-450"><span class="linenos">450</span></a> <span class="n">use_docker</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="VimGolfEnv-451"><a href="#VimGolfEnv-451"><span class="linenos">451</span></a> <span class="n">log_buffer</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="VimGolfEnv-452"><a href="#VimGolfEnv-452"><span class="linenos">452</span></a> <span class="p">):</span>
</span><span id="VimGolfEnv-453"><a href="#VimGolfEnv-453"><span class="linenos">453</span></a><span class="w"> </span><span class="sd">"""Initialize the environment with the given input and output files.</span>
</span><span id="VimGolfEnv-454"><a href="#VimGolfEnv-454"><span class="linenos">454</span></a>
</span><span id="VimGolfEnv-455"><a href="#VimGolfEnv-455"><span class="linenos">455</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv-456"><a href="#VimGolfEnv-456"><span class="linenos">456</span></a><span class="sd"> input_file (str): the input file path</span>
</span><span id="VimGolfEnv-457"><a href="#VimGolfEnv-457"><span class="linenos">457</span></a><span class="sd"> output_file (str): the output file path</span>
</span><span id="VimGolfEnv-458"><a href="#VimGolfEnv-458"><span class="linenos">458</span></a><span class="sd"> width (int): the width of the terminal</span>
</span><span id="VimGolfEnv-459"><a href="#VimGolfEnv-459"><span class="linenos">459</span></a><span class="sd"> height (int): the height of the terminal</span>
</span><span id="VimGolfEnv-460"><a href="#VimGolfEnv-460"><span class="linenos">460</span></a><span class="sd"> use_docker (bool): whether use dockerized executor or local (requiring vim installed)</span>
</span><span id="VimGolfEnv-461"><a href="#VimGolfEnv-461"><span class="linenos">461</span></a><span class="sd"> log_buffer (bool): whether to log the editor buffer or not</span>
</span><span id="VimGolfEnv-462"><a href="#VimGolfEnv-462"><span class="linenos">462</span></a><span class="sd"> init_keys (str): initial input keys in Vimgolf solution style</span>
</span><span id="VimGolfEnv-463"><a href="#VimGolfEnv-463"><span class="linenos">463</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-464"><a href="#VimGolfEnv-464"><span class="linenos">464</span></a>
</span><span id="VimGolfEnv-465"><a href="#VimGolfEnv-465"><span class="linenos">465</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span> <span class="o">=</span> <span class="n">use_docker</span>
</span><span id="VimGolfEnv-466"><a href="#VimGolfEnv-466"><span class="linenos">466</span></a><span class="w"> </span><span class="sd">"""whether use dockerized executor or local (requiring vim installed)"""</span>
</span><span id="VimGolfEnv-467"><a href="#VimGolfEnv-467"><span class="linenos">467</span></a>
</span><span id="VimGolfEnv-468"><a href="#VimGolfEnv-468"><span class="linenos">468</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span> <span class="o">=</span> <span class="n">input_file</span>
</span><span id="VimGolfEnv-469"><a href="#VimGolfEnv-469"><span class="linenos">469</span></a><span class="w"> </span><span class="sd">"""the input file path"""</span>
</span><span id="VimGolfEnv-470"><a href="#VimGolfEnv-470"><span class="linenos">470</span></a>
</span><span id="VimGolfEnv-471"><a href="#VimGolfEnv-471"><span class="linenos">471</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span> <span class="o">=</span> <span class="n">output_file</span>
</span><span id="VimGolfEnv-472"><a href="#VimGolfEnv-472"><span class="linenos">472</span></a><span class="w"> </span><span class="sd">"""the output file path"""</span>
</span><span id="VimGolfEnv-473"><a href="#VimGolfEnv-473"><span class="linenos">473</span></a>
</span><span id="VimGolfEnv-474"><a href="#VimGolfEnv-474"><span class="linenos">474</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span> <span class="o">=</span> <span class="n">log_buffer</span>
</span><span id="VimGolfEnv-475"><a href="#VimGolfEnv-475"><span class="linenos">475</span></a><span class="w"> </span><span class="sd">"""whether to log the editor buffer or not"""</span>
</span><span id="VimGolfEnv-476"><a href="#VimGolfEnv-476"><span class="linenos">476</span></a>
</span><span id="VimGolfEnv-477"><a href="#VimGolfEnv-477"><span class="linenos">477</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span> <span class="o">=</span> <span class="n">init_keys</span>
</span><span id="VimGolfEnv-478"><a href="#VimGolfEnv-478"><span class="linenos">478</span></a><span class="w"> </span><span class="sd">"""initial input keys in Vimgolf solution style"""</span>
</span><span id="VimGolfEnv-479"><a href="#VimGolfEnv-479"><span class="linenos">479</span></a>
</span><span id="VimGolfEnv-480"><a href="#VimGolfEnv-480"><span class="linenos">480</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span>
</span><span id="VimGolfEnv-481"><a href="#VimGolfEnv-481"><span class="linenos">481</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span>
</span><span id="VimGolfEnv-482"><a href="#VimGolfEnv-482"><span class="linenos">482</span></a> <span class="p">),</span> <span class="sa">f</span><span class="s2">"Input file </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="si">}</span><span class="s2"> does not exist."</span>
</span><span id="VimGolfEnv-483"><a href="#VimGolfEnv-483"><span class="linenos">483</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span>
</span><span id="VimGolfEnv-484"><a href="#VimGolfEnv-484"><span class="linenos">484</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span>
</span><span id="VimGolfEnv-485"><a href="#VimGolfEnv-485"><span class="linenos">485</span></a> <span class="p">),</span> <span class="sa">f</span><span class="s2">"Output file </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="si">}</span><span class="s2"> does not exist."</span>
</span><span id="VimGolfEnv-486"><a href="#VimGolfEnv-486"><span class="linenos">486</span></a>
</span><span id="VimGolfEnv-487"><a href="#VimGolfEnv-487"><span class="linenos">487</span></a> <span class="c1"># TODO: run a modified version of vimgolf local python script writing progress to a jsonl file, which embeds in this script, for easy state inspection and data collection (we can create a temporary directory for cleanup)</span>
</span><span id="VimGolfEnv-488"><a href="#VimGolfEnv-488"><span class="linenos">488</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span>
</span><span id="VimGolfEnv-489"><a href="#VimGolfEnv-489"><span class="linenos">489</span></a><span class="w"> </span><span class="sd">"""the log directory, where tempfiles stored"""</span>
</span><span id="VimGolfEnv-490"><a href="#VimGolfEnv-490"><span class="linenos">490</span></a>
</span><span id="VimGolfEnv-491"><a href="#VimGolfEnv-491"><span class="linenos">491</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"vimgolf.log"</span><span class="p">)</span>
</span><span id="VimGolfEnv-492"><a href="#VimGolfEnv-492"><span class="linenos">492</span></a><span class="w"> </span><span class="sd">"""the log file path, used to retrieve progress info of the vimgolf process"""</span>
</span><span id="VimGolfEnv-493"><a href="#VimGolfEnv-493"><span class="linenos">493</span></a>
</span><span id="VimGolfEnv-494"><a href="#VimGolfEnv-494"><span class="linenos">494</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="VimGolfEnv-495"><a href="#VimGolfEnv-495"><span class="linenos">495</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"vimgolf_editor_buffer"</span>
</span><span id="VimGolfEnv-496"><a href="#VimGolfEnv-496"><span class="linenos">496</span></a> <span class="p">)</span>
</span><span id="VimGolfEnv-497"><a href="#VimGolfEnv-497"><span class="linenos">497</span></a><span class="w"> </span><span class="sd">"""the editor buffer, used to track granual progress"""</span>
</span><span id="VimGolfEnv-498"><a href="#VimGolfEnv-498"><span class="linenos">498</span></a>
</span><span id="VimGolfEnv-499"><a href="#VimGolfEnv-499"><span class="linenos">499</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
</span><span id="VimGolfEnv-500"><a href="#VimGolfEnv-500"><span class="linenos">500</span></a>
</span><span id="VimGolfEnv-501"><a href="#VimGolfEnv-501"><span class="linenos">501</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">:</span>
</span><span id="VimGolfEnv-502"><a href="#VimGolfEnv-502"><span class="linenos">502</span></a> <span class="n">mountpoint</span> <span class="o">=</span> <span class="s2">"/vimgolf_gym_workdir"</span>
</span><span id="VimGolfEnv-503"><a href="#VimGolfEnv-503"><span class="linenos">503</span></a> <span class="n">docker_output_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"out"</span><span class="p">)</span>
</span><span id="VimGolfEnv-504"><a href="#VimGolfEnv-504"><span class="linenos">504</span></a> <span class="n">docker_input_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"in"</span><span class="p">)</span>
</span><span id="VimGolfEnv-505"><a href="#VimGolfEnv-505"><span class="linenos">505</span></a> <span class="n">docker_buffer_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"vimgolf_editor_buffer"</span><span class="p">)</span>
</span><span id="VimGolfEnv-506"><a href="#VimGolfEnv-506"><span class="linenos">506</span></a> <span class="n">docker_log_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"vimgolf.log"</span><span class="p">)</span>
</span><span id="VimGolfEnv-507"><a href="#VimGolfEnv-507"><span class="linenos">507</span></a> <span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"in"</span><span class="p">))</span>
</span><span id="VimGolfEnv-508"><a href="#VimGolfEnv-508"><span class="linenos">508</span></a> <span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"out"</span><span class="p">))</span>
</span><span id="VimGolfEnv-509"><a href="#VimGolfEnv-509"><span class="linenos">509</span></a> <span class="n">extra_docker_run_params</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="VimGolfEnv-510"><a href="#VimGolfEnv-510"><span class="linenos">510</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="VimGolfEnv-511"><a href="#VimGolfEnv-511"><span class="linenos">511</span></a> <span class="n">_prepare_cybergod_vimrc_with_buffer_file</span><span class="p">(</span><span class="n">docker_buffer_file</span><span class="p">)</span>
</span><span id="VimGolfEnv-512"><a href="#VimGolfEnv-512"><span class="linenos">512</span></a> <span class="n">extra_docker_run_params</span> <span class="o">+=</span> <span class="p">[</span>
</span><span id="VimGolfEnv-513"><a href="#VimGolfEnv-513"><span class="linenos">513</span></a> <span class="s2">"-v"</span><span class="p">,</span>
</span><span id="VimGolfEnv-514"><a href="#VimGolfEnv-514"><span class="linenos">514</span></a> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">:ro"</span>
</span><span id="VimGolfEnv-515"><a href="#VimGolfEnv-515"><span class="linenos">515</span></a> <span class="o">%</span> <span class="p">(</span>
</span><span id="VimGolfEnv-516"><a href="#VimGolfEnv-516"><span class="linenos">516</span></a> <span class="n">_CYBERGOD_VIMGOLF_VIMRC_FILEPATH</span><span class="p">,</span>
</span><span id="VimGolfEnv-517"><a href="#VimGolfEnv-517"><span class="linenos">517</span></a> <span class="s2">"/usr/local/lib/python3.10/dist-packages/vimgolf/vimgolf.vimrc"</span><span class="p">,</span>
</span><span id="VimGolfEnv-518"><a href="#VimGolfEnv-518"><span class="linenos">518</span></a> <span class="p">),</span>
</span><span id="VimGolfEnv-519"><a href="#VimGolfEnv-519"><span class="linenos">519</span></a> <span class="p">]</span>
</span><span id="VimGolfEnv-520"><a href="#VimGolfEnv-520"><span class="linenos">520</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="VimGolfEnv-521"><a href="#VimGolfEnv-521"><span class="linenos">521</span></a> <span class="s2">"docker"</span><span class="p">,</span>
</span><span id="VimGolfEnv-522"><a href="#VimGolfEnv-522"><span class="linenos">522</span></a> <span class="s2">"run"</span><span class="p">,</span>
</span><span id="VimGolfEnv-523"><a href="#VimGolfEnv-523"><span class="linenos">523</span></a> <span class="s2">"--rm"</span><span class="p">,</span>
</span><span id="VimGolfEnv-524"><a href="#VimGolfEnv-524"><span class="linenos">524</span></a> <span class="s2">"-it"</span><span class="p">,</span>
</span><span id="VimGolfEnv-525"><a href="#VimGolfEnv-525"><span class="linenos">525</span></a> <span class="s2">"--name"</span><span class="p">,</span>
</span><span id="VimGolfEnv-526"><a href="#VimGolfEnv-526"><span class="linenos">526</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span><span class="p">,</span>
</span><span id="VimGolfEnv-527"><a href="#VimGolfEnv-527"><span class="linenos">527</span></a> <span class="s2">"-v"</span><span class="p">,</span>
</span><span id="VimGolfEnv-528"><a href="#VimGolfEnv-528"><span class="linenos">528</span></a> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">mountpoint</span><span class="p">),</span>
</span><span id="VimGolfEnv-529"><a href="#VimGolfEnv-529"><span class="linenos">529</span></a> <span class="o">*</span><span class="n">extra_docker_run_params</span><span class="p">,</span>
</span><span id="VimGolfEnv-530"><a href="#VimGolfEnv-530"><span class="linenos">530</span></a> <span class="s2">"--entrypoint"</span><span class="p">,</span>
</span><span id="VimGolfEnv-531"><a href="#VimGolfEnv-531"><span class="linenos">531</span></a> <span class="s2">"python3"</span><span class="p">,</span>
</span><span id="VimGolfEnv-532"><a href="#VimGolfEnv-532"><span class="linenos">532</span></a> <span class="s2">"agile4im/cybergod_vimgolf_gym"</span><span class="p">,</span>
</span><span id="VimGolfEnv-533"><a href="#VimGolfEnv-533"><span class="linenos">533</span></a> <span class="s2">"-m"</span><span class="p">,</span>
</span><span id="VimGolfEnv-534"><a href="#VimGolfEnv-534"><span class="linenos">534</span></a> <span class="s2">"vimgolf_gym.vimgolf"</span><span class="p">,</span>
</span><span id="VimGolfEnv-535"><a href="#VimGolfEnv-535"><span class="linenos">535</span></a> <span class="s2">"--input_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv-536"><a href="#VimGolfEnv-536"><span class="linenos">536</span></a> <span class="n">docker_input_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-537"><a href="#VimGolfEnv-537"><span class="linenos">537</span></a> <span class="s2">"--output_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv-538"><a href="#VimGolfEnv-538"><span class="linenos">538</span></a> <span class="n">docker_output_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-539"><a href="#VimGolfEnv-539"><span class="linenos">539</span></a> <span class="s2">"--log_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv-540"><a href="#VimGolfEnv-540"><span class="linenos">540</span></a> <span class="n">docker_log_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-541"><a href="#VimGolfEnv-541"><span class="linenos">541</span></a> <span class="p">]</span>
</span><span id="VimGolfEnv-542"><a href="#VimGolfEnv-542"><span class="linenos">542</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">:</span>
</span><span id="VimGolfEnv-543"><a href="#VimGolfEnv-543"><span class="linenos">543</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--init_keys"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">]</span>
</span><span id="VimGolfEnv-544"><a href="#VimGolfEnv-544"><span class="linenos">544</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="VimGolfEnv-545"><a href="#VimGolfEnv-545"><span class="linenos">545</span></a> <span class="n">extra_flags</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="VimGolfEnv-546"><a href="#VimGolfEnv-546"><span class="linenos">546</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="VimGolfEnv-547"><a href="#VimGolfEnv-547"><span class="linenos">547</span></a> <span class="n">extra_flags</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--buffer_file"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">]</span>
</span><span id="VimGolfEnv-548"><a href="#VimGolfEnv-548"><span class="linenos">548</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">:</span>
</span><span id="VimGolfEnv-549"><a href="#VimGolfEnv-549"><span class="linenos">549</span></a> <span class="n">extra_flags</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--init_keys"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">]</span>
</span><span id="VimGolfEnv-550"><a href="#VimGolfEnv-550"><span class="linenos">550</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="VimGolfEnv-551"><a href="#VimGolfEnv-551"><span class="linenos">551</span></a> <span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="p">,</span>
</span><span id="VimGolfEnv-552"><a href="#VimGolfEnv-552"><span class="linenos">552</span></a> <span class="s2">"-m"</span><span class="p">,</span>
</span><span id="VimGolfEnv-553"><a href="#VimGolfEnv-553"><span class="linenos">553</span></a> <span class="s2">"vimgolf_gym.vimgolf"</span><span class="p">,</span>
</span><span id="VimGolfEnv-554"><a href="#VimGolfEnv-554"><span class="linenos">554</span></a> <span class="s2">"--input_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv-555"><a href="#VimGolfEnv-555"><span class="linenos">555</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-556"><a href="#VimGolfEnv-556"><span class="linenos">556</span></a> <span class="s2">"--output_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv-557"><a href="#VimGolfEnv-557"><span class="linenos">557</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-558"><a href="#VimGolfEnv-558"><span class="linenos">558</span></a> <span class="s2">"--log_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv-559"><a href="#VimGolfEnv-559"><span class="linenos">559</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-560"><a href="#VimGolfEnv-560"><span class="linenos">560</span></a> <span class="o">*</span><span class="n">extra_flags</span><span class="p">,</span>
</span><span id="VimGolfEnv-561"><a href="#VimGolfEnv-561"><span class="linenos">561</span></a> <span class="p">]</span>
</span><span id="VimGolfEnv-562"><a href="#VimGolfEnv-562"><span class="linenos">562</span></a>
</span><span id="VimGolfEnv-563"><a href="#VimGolfEnv-563"><span class="linenos">563</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="VimGolfEnv-564"><a href="#VimGolfEnv-564"><span class="linenos">564</span></a>
</span><span id="VimGolfEnv-565"><a href="#VimGolfEnv-565"><span class="linenos">565</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</span><span id="VimGolfEnv-566"><a href="#VimGolfEnv-566"><span class="linenos">566</span></a><span class="w"> </span><span class="sd">"""the command passed to underlying terminal executor"""</span>
</span><span id="VimGolfEnv-567"><a href="#VimGolfEnv-567"><span class="linenos">567</span></a>
</span><span id="VimGolfEnv-568"><a href="#VimGolfEnv-568"><span class="linenos">568</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="n">width</span>
</span><span id="VimGolfEnv-569"><a href="#VimGolfEnv-569"><span class="linenos">569</span></a><span class="w"> </span><span class="sd">"""terminal width"""</span>
</span><span id="VimGolfEnv-570"><a href="#VimGolfEnv-570"><span class="linenos">570</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">height</span> <span class="o">=</span> <span class="n">height</span>
</span><span id="VimGolfEnv-571"><a href="#VimGolfEnv-571"><span class="linenos">571</span></a><span class="w"> </span><span class="sd">"""terminal height"""</span>
</span><span id="VimGolfEnv-572"><a href="#VimGolfEnv-572"><span class="linenos">572</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">create_executor_and_log_watcher</span><span class="p">()</span>
</span><span id="VimGolfEnv-573"><a href="#VimGolfEnv-573"><span class="linenos">573</span></a>
</span><span id="VimGolfEnv-574"><a href="#VimGolfEnv-574"><span class="linenos">574</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="p">:</span> <span class="n">terminal_executor</span><span class="o">.</span><span class="n">TerminalExecutor</span>
</span><span id="VimGolfEnv-575"><a href="#VimGolfEnv-575"><span class="linenos">575</span></a><span class="w"> </span><span class="sd">"""terminal executor for running vimgolf process"""</span>
</span><span id="VimGolfEnv-576"><a href="#VimGolfEnv-576"><span class="linenos">576</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="p">:</span> <span class="n">log_parser</span><span class="o">.</span><span class="n">VimGolfLogWatcher</span>
</span><span id="VimGolfEnv-577"><a href="#VimGolfEnv-577"><span class="linenos">577</span></a><span class="w"> </span><span class="sd">"""log watcher for tracking vimgolf log output"""</span>
</span><span id="VimGolfEnv-578"><a href="#VimGolfEnv-578"><span class="linenos">578</span></a> <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">cleanup</span><span class="p">)</span>
</span><span id="VimGolfEnv-579"><a href="#VimGolfEnv-579"><span class="linenos">579</span></a> <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_kill_docker_container</span><span class="p">)</span>
</span><span id="VimGolfEnv-580"><a href="#VimGolfEnv-580"><span class="linenos">580</span></a>
</span><span id="VimGolfEnv-581"><a href="#VimGolfEnv-581"><span class="linenos">581</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv-582"><a href="#VimGolfEnv-582"><span class="linenos">582</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">buffer</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]:</span>
</span><span id="VimGolfEnv-583"><a href="#VimGolfEnv-583"><span class="linenos">583</span></a><span class="w"> </span><span class="sd">"""The editor buffer"""</span>
</span><span id="VimGolfEnv-584"><a href="#VimGolfEnv-584"><span class="linenos">584</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="VimGolfEnv-585"><a href="#VimGolfEnv-585"><span class="linenos">585</span></a> <span class="k">return</span> <span class="kc">None</span>
</span><span id="VimGolfEnv-586"><a href="#VimGolfEnv-586"><span class="linenos">586</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="VimGolfEnv-587"><a href="#VimGolfEnv-587"><span class="linenos">587</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">):</span>
</span><span id="VimGolfEnv-588"><a href="#VimGolfEnv-588"><span class="linenos">588</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv-589"><a href="#VimGolfEnv-589"><span class="linenos">589</span></a> <span class="k">return</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="VimGolfEnv-590"><a href="#VimGolfEnv-590"><span class="linenos">590</span></a>
</span><span id="VimGolfEnv-591"><a href="#VimGolfEnv-591"><span class="linenos">591</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">act</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="VimGolfEnv-592"><a href="#VimGolfEnv-592"><span class="linenos">592</span></a><span class="w"> </span><span class="sd">"""Take an action</span>
</span><span id="VimGolfEnv-593"><a href="#VimGolfEnv-593"><span class="linenos">593</span></a>
</span><span id="VimGolfEnv-594"><a href="#VimGolfEnv-594"><span class="linenos">594</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv-595"><a href="#VimGolfEnv-595"><span class="linenos">595</span></a><span class="sd"> action (str): the action to take</span>
</span><span id="VimGolfEnv-596"><a href="#VimGolfEnv-596"><span class="linenos">596</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-597"><a href="#VimGolfEnv-597"><span class="linenos">597</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
</span><span id="VimGolfEnv-598"><a href="#VimGolfEnv-598"><span class="linenos">598</span></a>
</span><span id="VimGolfEnv-599"><a href="#VimGolfEnv-599"><span class="linenos">599</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv-600"><a href="#VimGolfEnv-600"><span class="linenos">600</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">success</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-601"><a href="#VimGolfEnv-601"><span class="linenos">601</span></a><span class="w"> </span><span class="sd">"""Check if the vimgolf challenge has been solved successfully"""</span>
</span><span id="VimGolfEnv-602"><a href="#VimGolfEnv-602"><span class="linenos">602</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">success</span>
</span><span id="VimGolfEnv-603"><a href="#VimGolfEnv-603"><span class="linenos">603</span></a>
</span><span id="VimGolfEnv-604"><a href="#VimGolfEnv-604"><span class="linenos">604</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_best_success_result</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-605"><a href="#VimGolfEnv-605"><span class="linenos">605</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="VimGolfEnv-606"><a href="#VimGolfEnv-606"><span class="linenos">606</span></a><span class="sd"> Return the best success result in the log watcher.</span>
</span><span id="VimGolfEnv-607"><a href="#VimGolfEnv-607"><span class="linenos">607</span></a>
</span><span id="VimGolfEnv-608"><a href="#VimGolfEnv-608"><span class="linenos">608</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv-609"><a href="#VimGolfEnv-609"><span class="linenos">609</span></a><span class="sd"> Optional[VimGolfEnvResult]: The best success result.</span>
</span><span id="VimGolfEnv-610"><a href="#VimGolfEnv-610"><span class="linenos">610</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-611"><a href="#VimGolfEnv-611"><span class="linenos">611</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">get_best_success_result</span><span class="p">()</span>
</span><span id="VimGolfEnv-612"><a href="#VimGolfEnv-612"><span class="linenos">612</span></a>
</span><span id="VimGolfEnv-613"><a href="#VimGolfEnv-613"><span class="linenos">613</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_last_success_result</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-614"><a href="#VimGolfEnv-614"><span class="linenos">614</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="VimGolfEnv-615"><a href="#VimGolfEnv-615"><span class="linenos">615</span></a><span class="sd"> Return the last success result in the log watcher.</span>
</span><span id="VimGolfEnv-616"><a href="#VimGolfEnv-616"><span class="linenos">616</span></a>
</span><span id="VimGolfEnv-617"><a href="#VimGolfEnv-617"><span class="linenos">617</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv-618"><a href="#VimGolfEnv-618"><span class="linenos">618</span></a><span class="sd"> Optional[VimGolfEnvResult]: The last success result</span>
</span><span id="VimGolfEnv-619"><a href="#VimGolfEnv-619"><span class="linenos">619</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-620"><a href="#VimGolfEnv-620"><span class="linenos">620</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">get_last_success_result</span><span class="p">()</span>
</span><span id="VimGolfEnv-621"><a href="#VimGolfEnv-621"><span class="linenos">621</span></a>
</span><span id="VimGolfEnv-622"><a href="#VimGolfEnv-622"><span class="linenos">622</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv-623"><a href="#VimGolfEnv-623"><span class="linenos">623</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">results</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-624"><a href="#VimGolfEnv-624"><span class="linenos">624</span></a><span class="w"> </span><span class="sd">"""The results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv-625"><a href="#VimGolfEnv-625"><span class="linenos">625</span></a>
</span><span id="VimGolfEnv-626"><a href="#VimGolfEnv-626"><span class="linenos">626</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv-627"><a href="#VimGolfEnv-627"><span class="linenos">627</span></a><span class="sd"> list[VimGolfEnvResult]: The results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv-628"><a href="#VimGolfEnv-628"><span class="linenos">628</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-629"><a href="#VimGolfEnv-629"><span class="linenos">629</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">results</span>
</span><span id="VimGolfEnv-630"><a href="#VimGolfEnv-630"><span class="linenos">630</span></a>
</span><span id="VimGolfEnv-631"><a href="#VimGolfEnv-631"><span class="linenos">631</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-632"><a href="#VimGolfEnv-632"><span class="linenos">632</span></a> <span class="k">return</span> <span class="bp">self</span>
</span><span id="VimGolfEnv-633"><a href="#VimGolfEnv-633"><span class="linenos">633</span></a>
</span><span id="VimGolfEnv-634"><a href="#VimGolfEnv-634"><span class="linenos">634</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">tb</span><span class="p">):</span>
</span><span id="VimGolfEnv-635"><a href="#VimGolfEnv-635"><span class="linenos">635</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="VimGolfEnv-636"><a href="#VimGolfEnv-636"><span class="linenos">636</span></a>
</span><span id="VimGolfEnv-637"><a href="#VimGolfEnv-637"><span class="linenos">637</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv-638"><a href="#VimGolfEnv-638"><span class="linenos">638</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">success_results</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-639"><a href="#VimGolfEnv-639"><span class="linenos">639</span></a><span class="w"> </span><span class="sd">"""The success results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv-640"><a href="#VimGolfEnv-640"><span class="linenos">640</span></a>
</span><span id="VimGolfEnv-641"><a href="#VimGolfEnv-641"><span class="linenos">641</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv-642"><a href="#VimGolfEnv-642"><span class="linenos">642</span></a><span class="sd"> list[VimGolfEnvResult]: The success results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv-643"><a href="#VimGolfEnv-643"><span class="linenos">643</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-644"><a href="#VimGolfEnv-644"><span class="linenos">644</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">success_results</span>
</span><span id="VimGolfEnv-645"><a href="#VimGolfEnv-645"><span class="linenos">645</span></a>
</span><span id="VimGolfEnv-646"><a href="#VimGolfEnv-646"><span class="linenos">646</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">create_executor_and_log_watcher</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-647"><a href="#VimGolfEnv-647"><span class="linenos">647</span></a><span class="w"> </span><span class="sd">"""Create the executor and log watcher"""</span>
</span><span id="VimGolfEnv-648"><a href="#VimGolfEnv-648"><span class="linenos">648</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span> <span class="o">=</span> <span class="n">terminal_executor</span><span class="o">.</span><span class="n">TerminalExecutor</span><span class="p">(</span>
</span><span id="VimGolfEnv-649"><a href="#VimGolfEnv-649"><span class="linenos">649</span></a> <span class="n">command</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">height</span>
</span><span id="VimGolfEnv-650"><a href="#VimGolfEnv-650"><span class="linenos">650</span></a> <span class="p">)</span>
</span><span id="VimGolfEnv-651"><a href="#VimGolfEnv-651"><span class="linenos">651</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"log_watcher"</span><span class="p">):</span>
</span><span id="VimGolfEnv-652"><a href="#VimGolfEnv-652"><span class="linenos">652</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span> <span class="o">=</span> <span class="n">log_parser</span><span class="o">.</span><span class="n">VimGolfLogWatcher</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">)</span>
</span><span id="VimGolfEnv-653"><a href="#VimGolfEnv-653"><span class="linenos">653</span></a> <span class="c1"># shall we wait the executor be ready</span>
</span><span id="VimGolfEnv-654"><a href="#VimGolfEnv-654"><span class="linenos">654</span></a> <span class="c1"># we wait for the 'play(...)' indicator to appear in the log file.</span>
</span><span id="VimGolfEnv-655"><a href="#VimGolfEnv-655"><span class="linenos">655</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
</span><span id="VimGolfEnv-656"><a href="#VimGolfEnv-656"><span class="linenos">656</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">):</span>
</span><span id="VimGolfEnv-657"><a href="#VimGolfEnv-657"><span class="linenos">657</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv-658"><a href="#VimGolfEnv-658"><span class="linenos">658</span></a> <span class="n">log_content</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="VimGolfEnv-659"><a href="#VimGolfEnv-659"><span class="linenos">659</span></a> <span class="k">if</span> <span class="s2">"play(...)"</span> <span class="ow">in</span> <span class="n">log_content</span><span class="p">:</span>
</span><span id="VimGolfEnv-660"><a href="#VimGolfEnv-660"><span class="linenos">660</span></a> <span class="k">break</span>
</span><span id="VimGolfEnv-661"><a href="#VimGolfEnv-661"><span class="linenos">661</span></a> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.5</span><span class="p">)</span>
</span><span id="VimGolfEnv-662"><a href="#VimGolfEnv-662"><span class="linenos">662</span></a>
</span><span id="VimGolfEnv-663"><a href="#VimGolfEnv-663"><span class="linenos">663</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-664"><a href="#VimGolfEnv-664"><span class="linenos">664</span></a><span class="w"> </span><span class="sd">"""Reset the environment"""</span>
</span><span id="VimGolfEnv-665"><a href="#VimGolfEnv-665"><span class="linenos">665</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="VimGolfEnv-666"><a href="#VimGolfEnv-666"><span class="linenos">666</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="VimGolfEnv-667"><a href="#VimGolfEnv-667"><span class="linenos">667</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">create_executor_and_log_watcher</span><span class="p">()</span>
</span><span id="VimGolfEnv-668"><a href="#VimGolfEnv-668"><span class="linenos">668</span></a>
</span><span id="VimGolfEnv-669"><a href="#VimGolfEnv-669"><span class="linenos">669</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-670"><a href="#VimGolfEnv-670"><span class="linenos">670</span></a><span class="w"> </span><span class="sd">"""Render the environment"""</span>
</span><span id="VimGolfEnv-671"><a href="#VimGolfEnv-671"><span class="linenos">671</span></a> <span class="n">screenshot</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">screenshot</span><span class="p">()</span>
</span><span id="VimGolfEnv-672"><a href="#VimGolfEnv-672"><span class="linenos">672</span></a> <span class="c1"># display the screenshot</span>
</span><span id="VimGolfEnv-673"><a href="#VimGolfEnv-673"><span class="linenos">673</span></a> <span class="n">screenshot</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</span><span id="VimGolfEnv-674"><a href="#VimGolfEnv-674"><span class="linenos">674</span></a>
</span><span id="VimGolfEnv-675"><a href="#VimGolfEnv-675"><span class="linenos">675</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">screenshot</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-676"><a href="#VimGolfEnv-676"><span class="linenos">676</span></a><span class="w"> </span><span class="sd">"""Take a screenshot of the environment</span>
</span><span id="VimGolfEnv-677"><a href="#VimGolfEnv-677"><span class="linenos">677</span></a>
</span><span id="VimGolfEnv-678"><a href="#VimGolfEnv-678"><span class="linenos">678</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv-679"><a href="#VimGolfEnv-679"><span class="linenos">679</span></a><span class="sd"> PIL.Image.Image: The screenshot</span>
</span><span id="VimGolfEnv-680"><a href="#VimGolfEnv-680"><span class="linenos">680</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-681"><a href="#VimGolfEnv-681"><span class="linenos">681</span></a> <span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span> <span class="k">as</span> <span class="n">tmpdir</span><span class="p">:</span>
</span><span id="VimGolfEnv-682"><a href="#VimGolfEnv-682"><span class="linenos">682</span></a> <span class="n">png_tmpfile_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmpdir</span><span class="p">,</span> <span class="s2">"screenshot.png"</span><span class="p">)</span>
</span><span id="VimGolfEnv-683"><a href="#VimGolfEnv-683"><span class="linenos">683</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">screenshot</span><span class="p">(</span><span class="n">png_tmpfile_path</span><span class="p">)</span>
</span><span id="VimGolfEnv-684"><a href="#VimGolfEnv-684"><span class="linenos">684</span></a> <span class="n">image</span> <span class="o">=</span> <span class="n">PIL</span><span class="o">.</span><span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">png_tmpfile_path</span><span class="p">)</span>
</span><span id="VimGolfEnv-685"><a href="#VimGolfEnv-685"><span class="linenos">685</span></a> <span class="k">return</span> <span class="n">image</span>
</span><span id="VimGolfEnv-686"><a href="#VimGolfEnv-686"><span class="linenos">686</span></a>
</span><span id="VimGolfEnv-687"><a href="#VimGolfEnv-687"><span class="linenos">687</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">_kill_docker_container</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-688"><a href="#VimGolfEnv-688"><span class="linenos">688</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">:</span>
</span><span id="VimGolfEnv-689"><a href="#VimGolfEnv-689"><span class="linenos">689</span></a> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span>
</span><span id="VimGolfEnv-690"><a href="#VimGolfEnv-690"><span class="linenos">690</span></a> <span class="p">[</span><span class="s2">"docker"</span><span class="p">,</span> <span class="s2">"kill"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span><span class="p">],</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span>
</span><span id="VimGolfEnv-691"><a href="#VimGolfEnv-691"><span class="linenos">691</span></a> <span class="p">)</span>
</span><span id="VimGolfEnv-692"><a href="#VimGolfEnv-692"><span class="linenos">692</span></a>
</span><span id="VimGolfEnv-693"><a href="#VimGolfEnv-693"><span class="linenos">693</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">verify_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keys</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="VimGolfEnv-694"><a href="#VimGolfEnv-694"><span class="linenos">694</span></a><span class="w"> </span><span class="sd">"""Verify a solution by its keys</span>
</span><span id="VimGolfEnv-695"><a href="#VimGolfEnv-695"><span class="linenos">695</span></a>
</span><span id="VimGolfEnv-696"><a href="#VimGolfEnv-696"><span class="linenos">696</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv-697"><a href="#VimGolfEnv-697"><span class="linenos">697</span></a><span class="sd"> keys (str): the keys to verify, in Vimgolf style</span>
</span><span id="VimGolfEnv-698"><a href="#VimGolfEnv-698"><span class="linenos">698</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-699"><a href="#VimGolfEnv-699"><span class="linenos">699</span></a> <span class="k">assert</span> <span class="n">keys</span><span class="p">,</span> <span class="s2">"Keys cannot be empty"</span>
</span><span id="VimGolfEnv-700"><a href="#VimGolfEnv-700"><span class="linenos">700</span></a> <span class="k">with</span> <span class="n">VimGolfEnv</span><span class="p">(</span>
</span><span id="VimGolfEnv-701"><a href="#VimGolfEnv-701"><span class="linenos">701</span></a> <span class="n">input_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-702"><a href="#VimGolfEnv-702"><span class="linenos">702</span></a> <span class="n">output_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span>
</span><span id="VimGolfEnv-703"><a href="#VimGolfEnv-703"><span class="linenos">703</span></a> <span class="n">init_keys</span><span class="o">=</span><span class="n">keys</span><span class="p">,</span>
</span><span id="VimGolfEnv-704"><a href="#VimGolfEnv-704"><span class="linenos">704</span></a> <span class="n">use_docker</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">,</span>
</span><span id="VimGolfEnv-705"><a href="#VimGolfEnv-705"><span class="linenos">705</span></a> <span class="n">log_buffer</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
</span><span id="VimGolfEnv-706"><a href="#VimGolfEnv-706"><span class="linenos">706</span></a> <span class="p">)</span> <span class="k">as</span> <span class="n">env</span><span class="p">:</span>
</span><span id="VimGolfEnv-707"><a href="#VimGolfEnv-707"><span class="linenos">707</span></a> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">):</span>
</span><span id="VimGolfEnv-708"><a href="#VimGolfEnv-708"><span class="linenos">708</span></a> <span class="n">success</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">success</span>
</span><span id="VimGolfEnv-709"><a href="#VimGolfEnv-709"><span class="linenos">709</span></a> <span class="k">if</span> <span class="n">success</span><span class="p">:</span>
</span><span id="VimGolfEnv-710"><a href="#VimGolfEnv-710"><span class="linenos">710</span></a> <span class="k">break</span>
</span><span id="VimGolfEnv-711"><a href="#VimGolfEnv-711"><span class="linenos">711</span></a> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</span><span id="VimGolfEnv-712"><a href="#VimGolfEnv-712"><span class="linenos">712</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">success</span><span class="p">:</span>
</span><span id="VimGolfEnv-713"><a href="#VimGolfEnv-713"><span class="linenos">713</span></a> <span class="n">buffer</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">buffer</span>
</span><span id="VimGolfEnv-714"><a href="#VimGolfEnv-714"><span class="linenos">714</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv-715"><a href="#VimGolfEnv-715"><span class="linenos">715</span></a> <span class="n">expected_output</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="VimGolfEnv-716"><a href="#VimGolfEnv-716"><span class="linenos">716</span></a> <span class="n">success</span> <span class="o">=</span> <span class="n">buffer</span> <span class="o">==</span> <span class="n">expected_output</span>
</span><span id="VimGolfEnv-717"><a href="#VimGolfEnv-717"><span class="linenos">717</span></a> <span class="k">return</span> <span class="n">success</span>
</span><span id="VimGolfEnv-718"><a href="#VimGolfEnv-718"><span class="linenos">718</span></a>
</span><span id="VimGolfEnv-719"><a href="#VimGolfEnv-719"><span class="linenos">719</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv-720"><a href="#VimGolfEnv-720"><span class="linenos">720</span></a><span class="w"> </span><span class="sd">"""Close the environment"""</span>
</span><span id="VimGolfEnv-721"><a href="#VimGolfEnv-721"><span class="linenos">721</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span><span class="p">:</span>
</span><span id="VimGolfEnv-722"><a href="#VimGolfEnv-722"><span class="linenos">722</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">True</span>
</span><span id="VimGolfEnv-723"><a href="#VimGolfEnv-723"><span class="linenos">723</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="VimGolfEnv-724"><a href="#VimGolfEnv-724"><span class="linenos">724</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_kill_docker_container</span><span class="p">()</span>
</span><span id="VimGolfEnv-725"><a href="#VimGolfEnv-725"><span class="linenos">725</span></a> <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span>
</span><span id="VimGolfEnv-726"><a href="#VimGolfEnv-726"><span class="linenos">726</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">):</span>
</span><span id="VimGolfEnv-727"><a href="#VimGolfEnv-727"><span class="linenos">727</span></a> <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">)</span>
</span><span id="VimGolfEnv-728"><a href="#VimGolfEnv-728"><span class="linenos">728</span></a> <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"executor"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
</span><span id="VimGolfEnv-729"><a href="#VimGolfEnv-729"><span class="linenos">729</span></a>
</span><span id="VimGolfEnv-730"><a href="#VimGolfEnv-730"><span class="linenos">730</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">calculate_relative_inverse_score</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">score</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">worst_score</span><span class="p">:</span><span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span><span id="VimGolfEnv-731"><a href="#VimGolfEnv-731"><span class="linenos">731</span></a><span class="w"> </span><span class="sd">"""Calculate the relative inverse score of the given score</span>
</span><span id="VimGolfEnv-732"><a href="#VimGolfEnv-732"><span class="linenos">732</span></a><span class="sd"> </span>
</span><span id="VimGolfEnv-733"><a href="#VimGolfEnv-733"><span class="linenos">733</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv-734"><a href="#VimGolfEnv-734"><span class="linenos">734</span></a><span class="sd"> score (int): The score to calculate the relative inverse score of.</span>
</span><span id="VimGolfEnv-735"><a href="#VimGolfEnv-735"><span class="linenos">735</span></a><span class="sd"> worst_score (int, optional): The worst score to use. Defaults to None.</span>
</span><span id="VimGolfEnv-736"><a href="#VimGolfEnv-736"><span class="linenos">736</span></a>
</span><span id="VimGolfEnv-737"><a href="#VimGolfEnv-737"><span class="linenos">737</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv-738"><a href="#VimGolfEnv-738"><span class="linenos">738</span></a><span class="sd"> float: The relative inverse score.</span>
</span><span id="VimGolfEnv-739"><a href="#VimGolfEnv-739"><span class="linenos">739</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv-740"><a href="#VimGolfEnv-740"><span class="linenos">740</span></a> <span class="k">assert</span> <span class="n">score</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"Score must be non-negative"</span>
</span><span id="VimGolfEnv-741"><a href="#VimGolfEnv-741"><span class="linenos">741</span></a> <span class="k">if</span> <span class="n">worst_score</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="VimGolfEnv-742"><a href="#VimGolfEnv-742"><span class="linenos">742</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv-743"><a href="#VimGolfEnv-743"><span class="linenos">743</span></a> <span class="n">worst_score</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span> <span class="o">+</span> <span class="mi">10</span>
</span><span id="VimGolfEnv-744"><a href="#VimGolfEnv-744"><span class="linenos">744</span></a> <span class="n">ret</span> <span class="o">=</span> <span class="n">worst_score</span> <span class="o">/</span> <span class="n">score</span>
</span><span id="VimGolfEnv-745"><a href="#VimGolfEnv-745"><span class="linenos">745</span></a> <span class="k">return</span> <span class="n">ret</span>
</span></pre></div>
<div id="VimGolfEnv.__init__" class="classattr">
<input id="VimGolfEnv.__init__-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="name">VimGolfEnv</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">input_file</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">output_file</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">width</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">80</span>,</span><span class="param"> <span class="n">height</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">24</span>,</span><span class="param"> <span class="n">init_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">''</span>,</span><span class="param"> <span class="n">use_docker</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>,</span><span class="param"> <span class="n">log_buffer</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span></span>)</span>
<label class="view-source-button" for="VimGolfEnv.__init__-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.__init__"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.__init__-443"><a href="#VimGolfEnv.__init__-443"><span class="linenos">443</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
</span><span id="VimGolfEnv.__init__-444"><a href="#VimGolfEnv.__init__-444"><span class="linenos">444</span></a> <span class="bp">self</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-445"><a href="#VimGolfEnv.__init__-445"><span class="linenos">445</span></a> <span class="n">input_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-446"><a href="#VimGolfEnv.__init__-446"><span class="linenos">446</span></a> <span class="n">output_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-447"><a href="#VimGolfEnv.__init__-447"><span class="linenos">447</span></a> <span class="n">width</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">80</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-448"><a href="#VimGolfEnv.__init__-448"><span class="linenos">448</span></a> <span class="n">height</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">24</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-449"><a href="#VimGolfEnv.__init__-449"><span class="linenos">449</span></a> <span class="n">init_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-450"><a href="#VimGolfEnv.__init__-450"><span class="linenos">450</span></a> <span class="n">use_docker</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-451"><a href="#VimGolfEnv.__init__-451"><span class="linenos">451</span></a> <span class="n">log_buffer</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-452"><a href="#VimGolfEnv.__init__-452"><span class="linenos">452</span></a> <span class="p">):</span>
</span><span id="VimGolfEnv.__init__-453"><a href="#VimGolfEnv.__init__-453"><span class="linenos">453</span></a><span class="w"> </span><span class="sd">"""Initialize the environment with the given input and output files.</span>
</span><span id="VimGolfEnv.__init__-454"><a href="#VimGolfEnv.__init__-454"><span class="linenos">454</span></a>
</span><span id="VimGolfEnv.__init__-455"><a href="#VimGolfEnv.__init__-455"><span class="linenos">455</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv.__init__-456"><a href="#VimGolfEnv.__init__-456"><span class="linenos">456</span></a><span class="sd"> input_file (str): the input file path</span>
</span><span id="VimGolfEnv.__init__-457"><a href="#VimGolfEnv.__init__-457"><span class="linenos">457</span></a><span class="sd"> output_file (str): the output file path</span>
</span><span id="VimGolfEnv.__init__-458"><a href="#VimGolfEnv.__init__-458"><span class="linenos">458</span></a><span class="sd"> width (int): the width of the terminal</span>
</span><span id="VimGolfEnv.__init__-459"><a href="#VimGolfEnv.__init__-459"><span class="linenos">459</span></a><span class="sd"> height (int): the height of the terminal</span>
</span><span id="VimGolfEnv.__init__-460"><a href="#VimGolfEnv.__init__-460"><span class="linenos">460</span></a><span class="sd"> use_docker (bool): whether use dockerized executor or local (requiring vim installed)</span>
</span><span id="VimGolfEnv.__init__-461"><a href="#VimGolfEnv.__init__-461"><span class="linenos">461</span></a><span class="sd"> log_buffer (bool): whether to log the editor buffer or not</span>
</span><span id="VimGolfEnv.__init__-462"><a href="#VimGolfEnv.__init__-462"><span class="linenos">462</span></a><span class="sd"> init_keys (str): initial input keys in Vimgolf solution style</span>
</span><span id="VimGolfEnv.__init__-463"><a href="#VimGolfEnv.__init__-463"><span class="linenos">463</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.__init__-464"><a href="#VimGolfEnv.__init__-464"><span class="linenos">464</span></a>
</span><span id="VimGolfEnv.__init__-465"><a href="#VimGolfEnv.__init__-465"><span class="linenos">465</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span> <span class="o">=</span> <span class="n">use_docker</span>
</span><span id="VimGolfEnv.__init__-466"><a href="#VimGolfEnv.__init__-466"><span class="linenos">466</span></a><span class="w"> </span><span class="sd">"""whether use dockerized executor or local (requiring vim installed)"""</span>
</span><span id="VimGolfEnv.__init__-467"><a href="#VimGolfEnv.__init__-467"><span class="linenos">467</span></a>
</span><span id="VimGolfEnv.__init__-468"><a href="#VimGolfEnv.__init__-468"><span class="linenos">468</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span> <span class="o">=</span> <span class="n">input_file</span>
</span><span id="VimGolfEnv.__init__-469"><a href="#VimGolfEnv.__init__-469"><span class="linenos">469</span></a><span class="w"> </span><span class="sd">"""the input file path"""</span>
</span><span id="VimGolfEnv.__init__-470"><a href="#VimGolfEnv.__init__-470"><span class="linenos">470</span></a>
</span><span id="VimGolfEnv.__init__-471"><a href="#VimGolfEnv.__init__-471"><span class="linenos">471</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span> <span class="o">=</span> <span class="n">output_file</span>
</span><span id="VimGolfEnv.__init__-472"><a href="#VimGolfEnv.__init__-472"><span class="linenos">472</span></a><span class="w"> </span><span class="sd">"""the output file path"""</span>
</span><span id="VimGolfEnv.__init__-473"><a href="#VimGolfEnv.__init__-473"><span class="linenos">473</span></a>
</span><span id="VimGolfEnv.__init__-474"><a href="#VimGolfEnv.__init__-474"><span class="linenos">474</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span> <span class="o">=</span> <span class="n">log_buffer</span>
</span><span id="VimGolfEnv.__init__-475"><a href="#VimGolfEnv.__init__-475"><span class="linenos">475</span></a><span class="w"> </span><span class="sd">"""whether to log the editor buffer or not"""</span>
</span><span id="VimGolfEnv.__init__-476"><a href="#VimGolfEnv.__init__-476"><span class="linenos">476</span></a>
</span><span id="VimGolfEnv.__init__-477"><a href="#VimGolfEnv.__init__-477"><span class="linenos">477</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span> <span class="o">=</span> <span class="n">init_keys</span>
</span><span id="VimGolfEnv.__init__-478"><a href="#VimGolfEnv.__init__-478"><span class="linenos">478</span></a><span class="w"> </span><span class="sd">"""initial input keys in Vimgolf solution style"""</span>
</span><span id="VimGolfEnv.__init__-479"><a href="#VimGolfEnv.__init__-479"><span class="linenos">479</span></a>
</span><span id="VimGolfEnv.__init__-480"><a href="#VimGolfEnv.__init__-480"><span class="linenos">480</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span>
</span><span id="VimGolfEnv.__init__-481"><a href="#VimGolfEnv.__init__-481"><span class="linenos">481</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span>
</span><span id="VimGolfEnv.__init__-482"><a href="#VimGolfEnv.__init__-482"><span class="linenos">482</span></a> <span class="p">),</span> <span class="sa">f</span><span class="s2">"Input file </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="si">}</span><span class="s2"> does not exist."</span>
</span><span id="VimGolfEnv.__init__-483"><a href="#VimGolfEnv.__init__-483"><span class="linenos">483</span></a> <span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span>
</span><span id="VimGolfEnv.__init__-484"><a href="#VimGolfEnv.__init__-484"><span class="linenos">484</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span>
</span><span id="VimGolfEnv.__init__-485"><a href="#VimGolfEnv.__init__-485"><span class="linenos">485</span></a> <span class="p">),</span> <span class="sa">f</span><span class="s2">"Output file </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="si">}</span><span class="s2"> does not exist."</span>
</span><span id="VimGolfEnv.__init__-486"><a href="#VimGolfEnv.__init__-486"><span class="linenos">486</span></a>
</span><span id="VimGolfEnv.__init__-487"><a href="#VimGolfEnv.__init__-487"><span class="linenos">487</span></a> <span class="c1"># TODO: run a modified version of vimgolf local python script writing progress to a jsonl file, which embeds in this script, for easy state inspection and data collection (we can create a temporary directory for cleanup)</span>
</span><span id="VimGolfEnv.__init__-488"><a href="#VimGolfEnv.__init__-488"><span class="linenos">488</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span>
</span><span id="VimGolfEnv.__init__-489"><a href="#VimGolfEnv.__init__-489"><span class="linenos">489</span></a><span class="w"> </span><span class="sd">"""the log directory, where tempfiles stored"""</span>
</span><span id="VimGolfEnv.__init__-490"><a href="#VimGolfEnv.__init__-490"><span class="linenos">490</span></a>
</span><span id="VimGolfEnv.__init__-491"><a href="#VimGolfEnv.__init__-491"><span class="linenos">491</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"vimgolf.log"</span><span class="p">)</span>
</span><span id="VimGolfEnv.__init__-492"><a href="#VimGolfEnv.__init__-492"><span class="linenos">492</span></a><span class="w"> </span><span class="sd">"""the log file path, used to retrieve progress info of the vimgolf process"""</span>
</span><span id="VimGolfEnv.__init__-493"><a href="#VimGolfEnv.__init__-493"><span class="linenos">493</span></a>
</span><span id="VimGolfEnv.__init__-494"><a href="#VimGolfEnv.__init__-494"><span class="linenos">494</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
</span><span id="VimGolfEnv.__init__-495"><a href="#VimGolfEnv.__init__-495"><span class="linenos">495</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"vimgolf_editor_buffer"</span>
</span><span id="VimGolfEnv.__init__-496"><a href="#VimGolfEnv.__init__-496"><span class="linenos">496</span></a> <span class="p">)</span>
</span><span id="VimGolfEnv.__init__-497"><a href="#VimGolfEnv.__init__-497"><span class="linenos">497</span></a><span class="w"> </span><span class="sd">"""the editor buffer, used to track granual progress"""</span>
</span><span id="VimGolfEnv.__init__-498"><a href="#VimGolfEnv.__init__-498"><span class="linenos">498</span></a>
</span><span id="VimGolfEnv.__init__-499"><a href="#VimGolfEnv.__init__-499"><span class="linenos">499</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
</span><span id="VimGolfEnv.__init__-500"><a href="#VimGolfEnv.__init__-500"><span class="linenos">500</span></a>
</span><span id="VimGolfEnv.__init__-501"><a href="#VimGolfEnv.__init__-501"><span class="linenos">501</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">:</span>
</span><span id="VimGolfEnv.__init__-502"><a href="#VimGolfEnv.__init__-502"><span class="linenos">502</span></a> <span class="n">mountpoint</span> <span class="o">=</span> <span class="s2">"/vimgolf_gym_workdir"</span>
</span><span id="VimGolfEnv.__init__-503"><a href="#VimGolfEnv.__init__-503"><span class="linenos">503</span></a> <span class="n">docker_output_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"out"</span><span class="p">)</span>
</span><span id="VimGolfEnv.__init__-504"><a href="#VimGolfEnv.__init__-504"><span class="linenos">504</span></a> <span class="n">docker_input_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"in"</span><span class="p">)</span>
</span><span id="VimGolfEnv.__init__-505"><a href="#VimGolfEnv.__init__-505"><span class="linenos">505</span></a> <span class="n">docker_buffer_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"vimgolf_editor_buffer"</span><span class="p">)</span>
</span><span id="VimGolfEnv.__init__-506"><a href="#VimGolfEnv.__init__-506"><span class="linenos">506</span></a> <span class="n">docker_log_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mountpoint</span><span class="p">,</span> <span class="s2">"vimgolf.log"</span><span class="p">)</span>
</span><span id="VimGolfEnv.__init__-507"><a href="#VimGolfEnv.__init__-507"><span class="linenos">507</span></a> <span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"in"</span><span class="p">))</span>
</span><span id="VimGolfEnv.__init__-508"><a href="#VimGolfEnv.__init__-508"><span class="linenos">508</span></a> <span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"out"</span><span class="p">))</span>
</span><span id="VimGolfEnv.__init__-509"><a href="#VimGolfEnv.__init__-509"><span class="linenos">509</span></a> <span class="n">extra_docker_run_params</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="VimGolfEnv.__init__-510"><a href="#VimGolfEnv.__init__-510"><span class="linenos">510</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="VimGolfEnv.__init__-511"><a href="#VimGolfEnv.__init__-511"><span class="linenos">511</span></a> <span class="n">_prepare_cybergod_vimrc_with_buffer_file</span><span class="p">(</span><span class="n">docker_buffer_file</span><span class="p">)</span>
</span><span id="VimGolfEnv.__init__-512"><a href="#VimGolfEnv.__init__-512"><span class="linenos">512</span></a> <span class="n">extra_docker_run_params</span> <span class="o">+=</span> <span class="p">[</span>
</span><span id="VimGolfEnv.__init__-513"><a href="#VimGolfEnv.__init__-513"><span class="linenos">513</span></a> <span class="s2">"-v"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-514"><a href="#VimGolfEnv.__init__-514"><span class="linenos">514</span></a> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">:ro"</span>
</span><span id="VimGolfEnv.__init__-515"><a href="#VimGolfEnv.__init__-515"><span class="linenos">515</span></a> <span class="o">%</span> <span class="p">(</span>
</span><span id="VimGolfEnv.__init__-516"><a href="#VimGolfEnv.__init__-516"><span class="linenos">516</span></a> <span class="n">_CYBERGOD_VIMGOLF_VIMRC_FILEPATH</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-517"><a href="#VimGolfEnv.__init__-517"><span class="linenos">517</span></a> <span class="s2">"/usr/local/lib/python3.10/dist-packages/vimgolf/vimgolf.vimrc"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-518"><a href="#VimGolfEnv.__init__-518"><span class="linenos">518</span></a> <span class="p">),</span>
</span><span id="VimGolfEnv.__init__-519"><a href="#VimGolfEnv.__init__-519"><span class="linenos">519</span></a> <span class="p">]</span>
</span><span id="VimGolfEnv.__init__-520"><a href="#VimGolfEnv.__init__-520"><span class="linenos">520</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="VimGolfEnv.__init__-521"><a href="#VimGolfEnv.__init__-521"><span class="linenos">521</span></a> <span class="s2">"docker"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-522"><a href="#VimGolfEnv.__init__-522"><span class="linenos">522</span></a> <span class="s2">"run"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-523"><a href="#VimGolfEnv.__init__-523"><span class="linenos">523</span></a> <span class="s2">"--rm"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-524"><a href="#VimGolfEnv.__init__-524"><span class="linenos">524</span></a> <span class="s2">"-it"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-525"><a href="#VimGolfEnv.__init__-525"><span class="linenos">525</span></a> <span class="s2">"--name"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-526"><a href="#VimGolfEnv.__init__-526"><span class="linenos">526</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_container_name</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-527"><a href="#VimGolfEnv.__init__-527"><span class="linenos">527</span></a> <span class="s2">"-v"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-528"><a href="#VimGolfEnv.__init__-528"><span class="linenos">528</span></a> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">mountpoint</span><span class="p">),</span>
</span><span id="VimGolfEnv.__init__-529"><a href="#VimGolfEnv.__init__-529"><span class="linenos">529</span></a> <span class="o">*</span><span class="n">extra_docker_run_params</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-530"><a href="#VimGolfEnv.__init__-530"><span class="linenos">530</span></a> <span class="s2">"--entrypoint"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-531"><a href="#VimGolfEnv.__init__-531"><span class="linenos">531</span></a> <span class="s2">"python3"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-532"><a href="#VimGolfEnv.__init__-532"><span class="linenos">532</span></a> <span class="s2">"agile4im/cybergod_vimgolf_gym"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-533"><a href="#VimGolfEnv.__init__-533"><span class="linenos">533</span></a> <span class="s2">"-m"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-534"><a href="#VimGolfEnv.__init__-534"><span class="linenos">534</span></a> <span class="s2">"vimgolf_gym.vimgolf"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-535"><a href="#VimGolfEnv.__init__-535"><span class="linenos">535</span></a> <span class="s2">"--input_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-536"><a href="#VimGolfEnv.__init__-536"><span class="linenos">536</span></a> <span class="n">docker_input_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-537"><a href="#VimGolfEnv.__init__-537"><span class="linenos">537</span></a> <span class="s2">"--output_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-538"><a href="#VimGolfEnv.__init__-538"><span class="linenos">538</span></a> <span class="n">docker_output_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-539"><a href="#VimGolfEnv.__init__-539"><span class="linenos">539</span></a> <span class="s2">"--log_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-540"><a href="#VimGolfEnv.__init__-540"><span class="linenos">540</span></a> <span class="n">docker_log_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-541"><a href="#VimGolfEnv.__init__-541"><span class="linenos">541</span></a> <span class="p">]</span>
</span><span id="VimGolfEnv.__init__-542"><a href="#VimGolfEnv.__init__-542"><span class="linenos">542</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">:</span>
</span><span id="VimGolfEnv.__init__-543"><a href="#VimGolfEnv.__init__-543"><span class="linenos">543</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--init_keys"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">]</span>
</span><span id="VimGolfEnv.__init__-544"><a href="#VimGolfEnv.__init__-544"><span class="linenos">544</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="VimGolfEnv.__init__-545"><a href="#VimGolfEnv.__init__-545"><span class="linenos">545</span></a> <span class="n">extra_flags</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="VimGolfEnv.__init__-546"><a href="#VimGolfEnv.__init__-546"><span class="linenos">546</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="VimGolfEnv.__init__-547"><a href="#VimGolfEnv.__init__-547"><span class="linenos">547</span></a> <span class="n">extra_flags</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--buffer_file"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">]</span>
</span><span id="VimGolfEnv.__init__-548"><a href="#VimGolfEnv.__init__-548"><span class="linenos">548</span></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">:</span>
</span><span id="VimGolfEnv.__init__-549"><a href="#VimGolfEnv.__init__-549"><span class="linenos">549</span></a> <span class="n">extra_flags</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">"--init_keys"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_keys</span><span class="p">]</span>
</span><span id="VimGolfEnv.__init__-550"><a href="#VimGolfEnv.__init__-550"><span class="linenos">550</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="VimGolfEnv.__init__-551"><a href="#VimGolfEnv.__init__-551"><span class="linenos">551</span></a> <span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-552"><a href="#VimGolfEnv.__init__-552"><span class="linenos">552</span></a> <span class="s2">"-m"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-553"><a href="#VimGolfEnv.__init__-553"><span class="linenos">553</span></a> <span class="s2">"vimgolf_gym.vimgolf"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-554"><a href="#VimGolfEnv.__init__-554"><span class="linenos">554</span></a> <span class="s2">"--input_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-555"><a href="#VimGolfEnv.__init__-555"><span class="linenos">555</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-556"><a href="#VimGolfEnv.__init__-556"><span class="linenos">556</span></a> <span class="s2">"--output_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-557"><a href="#VimGolfEnv.__init__-557"><span class="linenos">557</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-558"><a href="#VimGolfEnv.__init__-558"><span class="linenos">558</span></a> <span class="s2">"--log_file"</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-559"><a href="#VimGolfEnv.__init__-559"><span class="linenos">559</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-560"><a href="#VimGolfEnv.__init__-560"><span class="linenos">560</span></a> <span class="o">*</span><span class="n">extra_flags</span><span class="p">,</span>
</span><span id="VimGolfEnv.__init__-561"><a href="#VimGolfEnv.__init__-561"><span class="linenos">561</span></a> <span class="p">]</span>
</span><span id="VimGolfEnv.__init__-562"><a href="#VimGolfEnv.__init__-562"><span class="linenos">562</span></a>
</span><span id="VimGolfEnv.__init__-563"><a href="#VimGolfEnv.__init__-563"><span class="linenos">563</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="VimGolfEnv.__init__-564"><a href="#VimGolfEnv.__init__-564"><span class="linenos">564</span></a>
</span><span id="VimGolfEnv.__init__-565"><a href="#VimGolfEnv.__init__-565"><span class="linenos">565</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</span><span id="VimGolfEnv.__init__-566"><a href="#VimGolfEnv.__init__-566"><span class="linenos">566</span></a><span class="w"> </span><span class="sd">"""the command passed to underlying terminal executor"""</span>
</span><span id="VimGolfEnv.__init__-567"><a href="#VimGolfEnv.__init__-567"><span class="linenos">567</span></a>
</span><span id="VimGolfEnv.__init__-568"><a href="#VimGolfEnv.__init__-568"><span class="linenos">568</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="n">width</span>
</span><span id="VimGolfEnv.__init__-569"><a href="#VimGolfEnv.__init__-569"><span class="linenos">569</span></a><span class="w"> </span><span class="sd">"""terminal width"""</span>
</span><span id="VimGolfEnv.__init__-570"><a href="#VimGolfEnv.__init__-570"><span class="linenos">570</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">height</span> <span class="o">=</span> <span class="n">height</span>
</span><span id="VimGolfEnv.__init__-571"><a href="#VimGolfEnv.__init__-571"><span class="linenos">571</span></a><span class="w"> </span><span class="sd">"""terminal height"""</span>
</span><span id="VimGolfEnv.__init__-572"><a href="#VimGolfEnv.__init__-572"><span class="linenos">572</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">create_executor_and_log_watcher</span><span class="p">()</span>
</span><span id="VimGolfEnv.__init__-573"><a href="#VimGolfEnv.__init__-573"><span class="linenos">573</span></a>
</span><span id="VimGolfEnv.__init__-574"><a href="#VimGolfEnv.__init__-574"><span class="linenos">574</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="p">:</span> <span class="n">terminal_executor</span><span class="o">.</span><span class="n">TerminalExecutor</span>
</span><span id="VimGolfEnv.__init__-575"><a href="#VimGolfEnv.__init__-575"><span class="linenos">575</span></a><span class="w"> </span><span class="sd">"""terminal executor for running vimgolf process"""</span>
</span><span id="VimGolfEnv.__init__-576"><a href="#VimGolfEnv.__init__-576"><span class="linenos">576</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="p">:</span> <span class="n">log_parser</span><span class="o">.</span><span class="n">VimGolfLogWatcher</span>
</span><span id="VimGolfEnv.__init__-577"><a href="#VimGolfEnv.__init__-577"><span class="linenos">577</span></a><span class="w"> </span><span class="sd">"""log watcher for tracking vimgolf log output"""</span>
</span><span id="VimGolfEnv.__init__-578"><a href="#VimGolfEnv.__init__-578"><span class="linenos">578</span></a> <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_directory</span><span class="o">.</span><span class="n">cleanup</span><span class="p">)</span>
</span><span id="VimGolfEnv.__init__-579"><a href="#VimGolfEnv.__init__-579"><span class="linenos">579</span></a> <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_kill_docker_container</span><span class="p">)</span>
</span></pre></div>
<div class="docstring"><p>Initialize the environment with the given input and output files.</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>input_file (str):</strong> the input file path</li>
<li><strong>output_file (str):</strong> the output file path</li>
<li><strong>width (int):</strong> the width of the terminal</li>
<li><strong>height (int):</strong> the height of the terminal</li>
<li><strong>use_docker (bool):</strong> whether use dockerized executor or local (requiring vim installed)</li>
<li><strong>log_buffer (bool):</strong> whether to log the editor buffer or not</li>
<li><strong>init_keys (str):</strong> initial input keys in Vimgolf solution style</li>
</ul>
</div>
</div>
<div id="VimGolfEnv.use_docker" class="classattr">
<div class="attr variable">
<span class="name">use_docker</span>
</div>
<a class="headerlink" href="#VimGolfEnv.use_docker"></a>
<div class="docstring"><p>whether use dockerized executor or local (requiring vim installed)</p>
</div>
</div>
<div id="VimGolfEnv.input_file" class="classattr">
<div class="attr variable">
<span class="name">input_file</span>
</div>
<a class="headerlink" href="#VimGolfEnv.input_file"></a>
<div class="docstring"><p>the input file path</p>
</div>
</div>
<div id="VimGolfEnv.output_file" class="classattr">
<div class="attr variable">
<span class="name">output_file</span>
</div>
<a class="headerlink" href="#VimGolfEnv.output_file"></a>
<div class="docstring"><p>the output file path</p>
</div>
</div>
<div id="VimGolfEnv.log_buffer" class="classattr">
<div class="attr variable">
<span class="name">log_buffer</span>
</div>
<a class="headerlink" href="#VimGolfEnv.log_buffer"></a>
<div class="docstring"><p>whether to log the editor buffer or not</p>
</div>
</div>
<div id="VimGolfEnv.init_keys" class="classattr">
<div class="attr variable">
<span class="name">init_keys</span>
</div>
<a class="headerlink" href="#VimGolfEnv.init_keys"></a>
<div class="docstring"><p>initial input keys in Vimgolf solution style</p>
</div>
</div>
<div id="VimGolfEnv.log_directory" class="classattr">
<div class="attr variable">
<span class="name">log_directory</span>
</div>
<a class="headerlink" href="#VimGolfEnv.log_directory"></a>
<div class="docstring"><p>the log directory, where tempfiles stored</p>
</div>
</div>
<div id="VimGolfEnv.log_file" class="classattr">
<div class="attr variable">
<span class="name">log_file</span>
</div>
<a class="headerlink" href="#VimGolfEnv.log_file"></a>
<div class="docstring"><p>the log file path, used to retrieve progress info of the vimgolf process</p>
</div>
</div>
<div id="VimGolfEnv.buffer_file" class="classattr">
<div class="attr variable">
<span class="name">buffer_file</span>
</div>
<a class="headerlink" href="#VimGolfEnv.buffer_file"></a>
<div class="docstring"><p>the editor buffer, used to track granual progress</p>
</div>
</div>
<div id="VimGolfEnv.command" class="classattr">
<div class="attr variable">
<span class="name">command</span><span class="annotation">: list[str]</span>
</div>
<a class="headerlink" href="#VimGolfEnv.command"></a>
<div class="docstring"><p>the command passed to underlying terminal executor</p>
</div>
</div>
<div id="VimGolfEnv.width" class="classattr">
<div class="attr variable">
<span class="name">width</span>
</div>
<a class="headerlink" href="#VimGolfEnv.width"></a>
<div class="docstring"><p>terminal width</p>
</div>
</div>
<div id="VimGolfEnv.height" class="classattr">
<div class="attr variable">
<span class="name">height</span>
</div>
<a class="headerlink" href="#VimGolfEnv.height"></a>
<div class="docstring"><p>terminal height</p>
</div>
</div>
<div id="VimGolfEnv.executor" class="classattr">
<div class="attr variable">
<span class="name">executor</span><span class="annotation">: <a href="terminal_executor.html#TerminalExecutor">vimgolf_gym.terminal_executor.TerminalExecutor</a></span>
</div>
<a class="headerlink" href="#VimGolfEnv.executor"></a>
<div class="docstring"><p>terminal executor for running vimgolf process</p>
</div>
</div>
<div id="VimGolfEnv.log_watcher" class="classattr">
<div class="attr variable">
<span class="name">log_watcher</span><span class="annotation">: <a href="log_parser.html#VimGolfLogWatcher">vimgolf_gym.log_parser.VimGolfLogWatcher</a></span>
</div>
<a class="headerlink" href="#VimGolfEnv.log_watcher"></a>
<div class="docstring"><p>log watcher for tracking vimgolf log output</p>
</div>
</div>
<div id="VimGolfEnv.buffer" class="classattr">
<input id="VimGolfEnv.buffer-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">buffer</span><span class="annotation">: Optional[bytes]</span>
<label class="view-source-button" for="VimGolfEnv.buffer-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.buffer"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.buffer-581"><a href="#VimGolfEnv.buffer-581"><span class="linenos">581</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv.buffer-582"><a href="#VimGolfEnv.buffer-582"><span class="linenos">582</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">buffer</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]:</span>
</span><span id="VimGolfEnv.buffer-583"><a href="#VimGolfEnv.buffer-583"><span class="linenos">583</span></a><span class="w"> </span><span class="sd">"""The editor buffer"""</span>
</span><span id="VimGolfEnv.buffer-584"><a href="#VimGolfEnv.buffer-584"><span class="linenos">584</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_buffer</span><span class="p">:</span>
</span><span id="VimGolfEnv.buffer-585"><a href="#VimGolfEnv.buffer-585"><span class="linenos">585</span></a> <span class="k">return</span> <span class="kc">None</span>
</span><span id="VimGolfEnv.buffer-586"><a href="#VimGolfEnv.buffer-586"><span class="linenos">586</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="VimGolfEnv.buffer-587"><a href="#VimGolfEnv.buffer-587"><span class="linenos">587</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">):</span>
</span><span id="VimGolfEnv.buffer-588"><a href="#VimGolfEnv.buffer-588"><span class="linenos">588</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buffer_file</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv.buffer-589"><a href="#VimGolfEnv.buffer-589"><span class="linenos">589</span></a> <span class="k">return</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span></pre></div>
<div class="docstring"><p>The editor buffer</p>
</div>
</div>
<div id="VimGolfEnv.act" class="classattr">
<input id="VimGolfEnv.act-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">act</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">action</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.act-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.act"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.act-591"><a href="#VimGolfEnv.act-591"><span class="linenos">591</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">act</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="VimGolfEnv.act-592"><a href="#VimGolfEnv.act-592"><span class="linenos">592</span></a><span class="w"> </span><span class="sd">"""Take an action</span>
</span><span id="VimGolfEnv.act-593"><a href="#VimGolfEnv.act-593"><span class="linenos">593</span></a>
</span><span id="VimGolfEnv.act-594"><a href="#VimGolfEnv.act-594"><span class="linenos">594</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv.act-595"><a href="#VimGolfEnv.act-595"><span class="linenos">595</span></a><span class="sd"> action (str): the action to take</span>
</span><span id="VimGolfEnv.act-596"><a href="#VimGolfEnv.act-596"><span class="linenos">596</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.act-597"><a href="#VimGolfEnv.act-597"><span class="linenos">597</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
</span></pre></div>
<div class="docstring"><p>Take an action</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>action (str):</strong> the action to take</li>
</ul>
</div>
</div>
<div id="VimGolfEnv.success" class="classattr">
<input id="VimGolfEnv.success-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">success</span>
<label class="view-source-button" for="VimGolfEnv.success-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.success"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.success-599"><a href="#VimGolfEnv.success-599"><span class="linenos">599</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv.success-600"><a href="#VimGolfEnv.success-600"><span class="linenos">600</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">success</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.success-601"><a href="#VimGolfEnv.success-601"><span class="linenos">601</span></a><span class="w"> </span><span class="sd">"""Check if the vimgolf challenge has been solved successfully"""</span>
</span><span id="VimGolfEnv.success-602"><a href="#VimGolfEnv.success-602"><span class="linenos">602</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">success</span>
</span></pre></div>
<div class="docstring"><p>Check if the vimgolf challenge has been solved successfully</p>
</div>
</div>
<div id="VimGolfEnv.get_best_success_result" class="classattr">
<input id="VimGolfEnv.get_best_success_result-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">get_best_success_result</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.get_best_success_result-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.get_best_success_result"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.get_best_success_result-604"><a href="#VimGolfEnv.get_best_success_result-604"><span class="linenos">604</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_best_success_result</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.get_best_success_result-605"><a href="#VimGolfEnv.get_best_success_result-605"><span class="linenos">605</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="VimGolfEnv.get_best_success_result-606"><a href="#VimGolfEnv.get_best_success_result-606"><span class="linenos">606</span></a><span class="sd"> Return the best success result in the log watcher.</span>
</span><span id="VimGolfEnv.get_best_success_result-607"><a href="#VimGolfEnv.get_best_success_result-607"><span class="linenos">607</span></a>
</span><span id="VimGolfEnv.get_best_success_result-608"><a href="#VimGolfEnv.get_best_success_result-608"><span class="linenos">608</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv.get_best_success_result-609"><a href="#VimGolfEnv.get_best_success_result-609"><span class="linenos">609</span></a><span class="sd"> Optional[VimGolfEnvResult]: The best success result.</span>
</span><span id="VimGolfEnv.get_best_success_result-610"><a href="#VimGolfEnv.get_best_success_result-610"><span class="linenos">610</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.get_best_success_result-611"><a href="#VimGolfEnv.get_best_success_result-611"><span class="linenos">611</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">get_best_success_result</span><span class="p">()</span>
</span></pre></div>
<div class="docstring"><p>Return the best success result in the log watcher.</p>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>Optional[VimGolfEnvResult]: The best success result.</p>
</blockquote>
</div>
</div>
<div id="VimGolfEnv.get_last_success_result" class="classattr">
<input id="VimGolfEnv.get_last_success_result-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">get_last_success_result</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.get_last_success_result-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.get_last_success_result"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.get_last_success_result-613"><a href="#VimGolfEnv.get_last_success_result-613"><span class="linenos">613</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_last_success_result</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.get_last_success_result-614"><a href="#VimGolfEnv.get_last_success_result-614"><span class="linenos">614</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="VimGolfEnv.get_last_success_result-615"><a href="#VimGolfEnv.get_last_success_result-615"><span class="linenos">615</span></a><span class="sd"> Return the last success result in the log watcher.</span>
</span><span id="VimGolfEnv.get_last_success_result-616"><a href="#VimGolfEnv.get_last_success_result-616"><span class="linenos">616</span></a>
</span><span id="VimGolfEnv.get_last_success_result-617"><a href="#VimGolfEnv.get_last_success_result-617"><span class="linenos">617</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv.get_last_success_result-618"><a href="#VimGolfEnv.get_last_success_result-618"><span class="linenos">618</span></a><span class="sd"> Optional[VimGolfEnvResult]: The last success result</span>
</span><span id="VimGolfEnv.get_last_success_result-619"><a href="#VimGolfEnv.get_last_success_result-619"><span class="linenos">619</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.get_last_success_result-620"><a href="#VimGolfEnv.get_last_success_result-620"><span class="linenos">620</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">get_last_success_result</span><span class="p">()</span>
</span></pre></div>
<div class="docstring"><p>Return the last success result in the log watcher.</p>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>Optional[VimGolfEnvResult]: The last success result</p>
</blockquote>
</div>
</div>
<div id="VimGolfEnv.results" class="classattr">
<input id="VimGolfEnv.results-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">results</span>
<label class="view-source-button" for="VimGolfEnv.results-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.results"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.results-622"><a href="#VimGolfEnv.results-622"><span class="linenos">622</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv.results-623"><a href="#VimGolfEnv.results-623"><span class="linenos">623</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">results</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.results-624"><a href="#VimGolfEnv.results-624"><span class="linenos">624</span></a><span class="w"> </span><span class="sd">"""The results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv.results-625"><a href="#VimGolfEnv.results-625"><span class="linenos">625</span></a>
</span><span id="VimGolfEnv.results-626"><a href="#VimGolfEnv.results-626"><span class="linenos">626</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv.results-627"><a href="#VimGolfEnv.results-627"><span class="linenos">627</span></a><span class="sd"> list[VimGolfEnvResult]: The results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv.results-628"><a href="#VimGolfEnv.results-628"><span class="linenos">628</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.results-629"><a href="#VimGolfEnv.results-629"><span class="linenos">629</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">results</span>
</span></pre></div>
<div class="docstring"><p>The results of the vimgolf challenge environment</p>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>list[VimGolfEnvResult]: The results of the vimgolf challenge environment</p>
</blockquote>
</div>
</div>
<div id="VimGolfEnv.success_results" class="classattr">
<input id="VimGolfEnv.success_results-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">success_results</span>
<label class="view-source-button" for="VimGolfEnv.success_results-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.success_results"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.success_results-637"><a href="#VimGolfEnv.success_results-637"><span class="linenos">637</span></a> <span class="nd">@property</span>
</span><span id="VimGolfEnv.success_results-638"><a href="#VimGolfEnv.success_results-638"><span class="linenos">638</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">success_results</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.success_results-639"><a href="#VimGolfEnv.success_results-639"><span class="linenos">639</span></a><span class="w"> </span><span class="sd">"""The success results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv.success_results-640"><a href="#VimGolfEnv.success_results-640"><span class="linenos">640</span></a>
</span><span id="VimGolfEnv.success_results-641"><a href="#VimGolfEnv.success_results-641"><span class="linenos">641</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv.success_results-642"><a href="#VimGolfEnv.success_results-642"><span class="linenos">642</span></a><span class="sd"> list[VimGolfEnvResult]: The success results of the vimgolf challenge environment</span>
</span><span id="VimGolfEnv.success_results-643"><a href="#VimGolfEnv.success_results-643"><span class="linenos">643</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.success_results-644"><a href="#VimGolfEnv.success_results-644"><span class="linenos">644</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span><span class="o">.</span><span class="n">success_results</span>
</span></pre></div>
<div class="docstring"><p>The success results of the vimgolf challenge environment</p>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>list[VimGolfEnvResult]: The success results of the vimgolf challenge environment</p>
</blockquote>
</div>
</div>
<div id="VimGolfEnv.create_executor_and_log_watcher" class="classattr">
<input id="VimGolfEnv.create_executor_and_log_watcher-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">create_executor_and_log_watcher</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.create_executor_and_log_watcher-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.create_executor_and_log_watcher"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.create_executor_and_log_watcher-646"><a href="#VimGolfEnv.create_executor_and_log_watcher-646"><span class="linenos">646</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">create_executor_and_log_watcher</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-647"><a href="#VimGolfEnv.create_executor_and_log_watcher-647"><span class="linenos">647</span></a><span class="w"> </span><span class="sd">"""Create the executor and log watcher"""</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-648"><a href="#VimGolfEnv.create_executor_and_log_watcher-648"><span class="linenos">648</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span> <span class="o">=</span> <span class="n">terminal_executor</span><span class="o">.</span><span class="n">TerminalExecutor</span><span class="p">(</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-649"><a href="#VimGolfEnv.create_executor_and_log_watcher-649"><span class="linenos">649</span></a> <span class="n">command</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">height</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-650"><a href="#VimGolfEnv.create_executor_and_log_watcher-650"><span class="linenos">650</span></a> <span class="p">)</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-651"><a href="#VimGolfEnv.create_executor_and_log_watcher-651"><span class="linenos">651</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"log_watcher"</span><span class="p">):</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-652"><a href="#VimGolfEnv.create_executor_and_log_watcher-652"><span class="linenos">652</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">log_watcher</span> <span class="o">=</span> <span class="n">log_parser</span><span class="o">.</span><span class="n">VimGolfLogWatcher</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">)</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-653"><a href="#VimGolfEnv.create_executor_and_log_watcher-653"><span class="linenos">653</span></a> <span class="c1"># shall we wait the executor be ready</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-654"><a href="#VimGolfEnv.create_executor_and_log_watcher-654"><span class="linenos">654</span></a> <span class="c1"># we wait for the 'play(...)' indicator to appear in the log file.</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-655"><a href="#VimGolfEnv.create_executor_and_log_watcher-655"><span class="linenos">655</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-656"><a href="#VimGolfEnv.create_executor_and_log_watcher-656"><span class="linenos">656</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">):</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-657"><a href="#VimGolfEnv.create_executor_and_log_watcher-657"><span class="linenos">657</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-658"><a href="#VimGolfEnv.create_executor_and_log_watcher-658"><span class="linenos">658</span></a> <span class="n">log_content</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-659"><a href="#VimGolfEnv.create_executor_and_log_watcher-659"><span class="linenos">659</span></a> <span class="k">if</span> <span class="s2">"play(...)"</span> <span class="ow">in</span> <span class="n">log_content</span><span class="p">:</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-660"><a href="#VimGolfEnv.create_executor_and_log_watcher-660"><span class="linenos">660</span></a> <span class="k">break</span>
</span><span id="VimGolfEnv.create_executor_and_log_watcher-661"><a href="#VimGolfEnv.create_executor_and_log_watcher-661"><span class="linenos">661</span></a> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.5</span><span class="p">)</span>
</span></pre></div>
<div class="docstring"><p>Create the executor and log watcher</p>
</div>
</div>
<div id="VimGolfEnv.reset" class="classattr">
<input id="VimGolfEnv.reset-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">reset</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.reset-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.reset"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.reset-663"><a href="#VimGolfEnv.reset-663"><span class="linenos">663</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.reset-664"><a href="#VimGolfEnv.reset-664"><span class="linenos">664</span></a><span class="w"> </span><span class="sd">"""Reset the environment"""</span>
</span><span id="VimGolfEnv.reset-665"><a href="#VimGolfEnv.reset-665"><span class="linenos">665</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="VimGolfEnv.reset-666"><a href="#VimGolfEnv.reset-666"><span class="linenos">666</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="VimGolfEnv.reset-667"><a href="#VimGolfEnv.reset-667"><span class="linenos">667</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">create_executor_and_log_watcher</span><span class="p">()</span>
</span></pre></div>
<div class="docstring"><p>Reset the environment</p>
</div>
</div>
<div id="VimGolfEnv.render" class="classattr">
<input id="VimGolfEnv.render-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">render</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.render-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.render"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.render-669"><a href="#VimGolfEnv.render-669"><span class="linenos">669</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.render-670"><a href="#VimGolfEnv.render-670"><span class="linenos">670</span></a><span class="w"> </span><span class="sd">"""Render the environment"""</span>
</span><span id="VimGolfEnv.render-671"><a href="#VimGolfEnv.render-671"><span class="linenos">671</span></a> <span class="n">screenshot</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">screenshot</span><span class="p">()</span>
</span><span id="VimGolfEnv.render-672"><a href="#VimGolfEnv.render-672"><span class="linenos">672</span></a> <span class="c1"># display the screenshot</span>
</span><span id="VimGolfEnv.render-673"><a href="#VimGolfEnv.render-673"><span class="linenos">673</span></a> <span class="n">screenshot</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</span></pre></div>
<div class="docstring"><p>Render the environment</p>
</div>
</div>
<div id="VimGolfEnv.screenshot" class="classattr">
<input id="VimGolfEnv.screenshot-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">screenshot</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.screenshot-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.screenshot"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.screenshot-675"><a href="#VimGolfEnv.screenshot-675"><span class="linenos">675</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">screenshot</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.screenshot-676"><a href="#VimGolfEnv.screenshot-676"><span class="linenos">676</span></a><span class="w"> </span><span class="sd">"""Take a screenshot of the environment</span>
</span><span id="VimGolfEnv.screenshot-677"><a href="#VimGolfEnv.screenshot-677"><span class="linenos">677</span></a>
</span><span id="VimGolfEnv.screenshot-678"><a href="#VimGolfEnv.screenshot-678"><span class="linenos">678</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv.screenshot-679"><a href="#VimGolfEnv.screenshot-679"><span class="linenos">679</span></a><span class="sd"> PIL.Image.Image: The screenshot</span>
</span><span id="VimGolfEnv.screenshot-680"><a href="#VimGolfEnv.screenshot-680"><span class="linenos">680</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.screenshot-681"><a href="#VimGolfEnv.screenshot-681"><span class="linenos">681</span></a> <span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span> <span class="k">as</span> <span class="n">tmpdir</span><span class="p">:</span>
</span><span id="VimGolfEnv.screenshot-682"><a href="#VimGolfEnv.screenshot-682"><span class="linenos">682</span></a> <span class="n">png_tmpfile_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmpdir</span><span class="p">,</span> <span class="s2">"screenshot.png"</span><span class="p">)</span>
</span><span id="VimGolfEnv.screenshot-683"><a href="#VimGolfEnv.screenshot-683"><span class="linenos">683</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">screenshot</span><span class="p">(</span><span class="n">png_tmpfile_path</span><span class="p">)</span>
</span><span id="VimGolfEnv.screenshot-684"><a href="#VimGolfEnv.screenshot-684"><span class="linenos">684</span></a> <span class="n">image</span> <span class="o">=</span> <span class="n">PIL</span><span class="o">.</span><span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">png_tmpfile_path</span><span class="p">)</span>
</span><span id="VimGolfEnv.screenshot-685"><a href="#VimGolfEnv.screenshot-685"><span class="linenos">685</span></a> <span class="k">return</span> <span class="n">image</span>
</span></pre></div>
<div class="docstring"><p>Take a screenshot of the environment</p>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>PIL.Image.Image: The screenshot</p>
</blockquote>
</div>
</div>
<div id="VimGolfEnv.verify_keys" class="classattr">
<input id="VimGolfEnv.verify_keys-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">verify_keys</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">keys</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.verify_keys-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.verify_keys"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.verify_keys-693"><a href="#VimGolfEnv.verify_keys-693"><span class="linenos">693</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">verify_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keys</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="VimGolfEnv.verify_keys-694"><a href="#VimGolfEnv.verify_keys-694"><span class="linenos">694</span></a><span class="w"> </span><span class="sd">"""Verify a solution by its keys</span>
</span><span id="VimGolfEnv.verify_keys-695"><a href="#VimGolfEnv.verify_keys-695"><span class="linenos">695</span></a>
</span><span id="VimGolfEnv.verify_keys-696"><a href="#VimGolfEnv.verify_keys-696"><span class="linenos">696</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv.verify_keys-697"><a href="#VimGolfEnv.verify_keys-697"><span class="linenos">697</span></a><span class="sd"> keys (str): the keys to verify, in Vimgolf style</span>
</span><span id="VimGolfEnv.verify_keys-698"><a href="#VimGolfEnv.verify_keys-698"><span class="linenos">698</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.verify_keys-699"><a href="#VimGolfEnv.verify_keys-699"><span class="linenos">699</span></a> <span class="k">assert</span> <span class="n">keys</span><span class="p">,</span> <span class="s2">"Keys cannot be empty"</span>
</span><span id="VimGolfEnv.verify_keys-700"><a href="#VimGolfEnv.verify_keys-700"><span class="linenos">700</span></a> <span class="k">with</span> <span class="n">VimGolfEnv</span><span class="p">(</span>
</span><span id="VimGolfEnv.verify_keys-701"><a href="#VimGolfEnv.verify_keys-701"><span class="linenos">701</span></a> <span class="n">input_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.verify_keys-702"><a href="#VimGolfEnv.verify_keys-702"><span class="linenos">702</span></a> <span class="n">output_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span>
</span><span id="VimGolfEnv.verify_keys-703"><a href="#VimGolfEnv.verify_keys-703"><span class="linenos">703</span></a> <span class="n">init_keys</span><span class="o">=</span><span class="n">keys</span><span class="p">,</span>
</span><span id="VimGolfEnv.verify_keys-704"><a href="#VimGolfEnv.verify_keys-704"><span class="linenos">704</span></a> <span class="n">use_docker</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">use_docker</span><span class="p">,</span>
</span><span id="VimGolfEnv.verify_keys-705"><a href="#VimGolfEnv.verify_keys-705"><span class="linenos">705</span></a> <span class="n">log_buffer</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
</span><span id="VimGolfEnv.verify_keys-706"><a href="#VimGolfEnv.verify_keys-706"><span class="linenos">706</span></a> <span class="p">)</span> <span class="k">as</span> <span class="n">env</span><span class="p">:</span>
</span><span id="VimGolfEnv.verify_keys-707"><a href="#VimGolfEnv.verify_keys-707"><span class="linenos">707</span></a> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">):</span>
</span><span id="VimGolfEnv.verify_keys-708"><a href="#VimGolfEnv.verify_keys-708"><span class="linenos">708</span></a> <span class="n">success</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">success</span>
</span><span id="VimGolfEnv.verify_keys-709"><a href="#VimGolfEnv.verify_keys-709"><span class="linenos">709</span></a> <span class="k">if</span> <span class="n">success</span><span class="p">:</span>
</span><span id="VimGolfEnv.verify_keys-710"><a href="#VimGolfEnv.verify_keys-710"><span class="linenos">710</span></a> <span class="k">break</span>
</span><span id="VimGolfEnv.verify_keys-711"><a href="#VimGolfEnv.verify_keys-711"><span class="linenos">711</span></a> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</span><span id="VimGolfEnv.verify_keys-712"><a href="#VimGolfEnv.verify_keys-712"><span class="linenos">712</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">success</span><span class="p">:</span>
</span><span id="VimGolfEnv.verify_keys-713"><a href="#VimGolfEnv.verify_keys-713"><span class="linenos">713</span></a> <span class="n">buffer</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">buffer</span>
</span><span id="VimGolfEnv.verify_keys-714"><a href="#VimGolfEnv.verify_keys-714"><span class="linenos">714</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv.verify_keys-715"><a href="#VimGolfEnv.verify_keys-715"><span class="linenos">715</span></a> <span class="n">expected_output</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</span><span id="VimGolfEnv.verify_keys-716"><a href="#VimGolfEnv.verify_keys-716"><span class="linenos">716</span></a> <span class="n">success</span> <span class="o">=</span> <span class="n">buffer</span> <span class="o">==</span> <span class="n">expected_output</span>
</span><span id="VimGolfEnv.verify_keys-717"><a href="#VimGolfEnv.verify_keys-717"><span class="linenos">717</span></a> <span class="k">return</span> <span class="n">success</span>
</span></pre></div>
<div class="docstring"><p>Verify a solution by its keys</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>keys (str):</strong> the keys to verify, in Vimgolf style</li>
</ul>
</div>
</div>
<div id="VimGolfEnv.close" class="classattr">
<input id="VimGolfEnv.close-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">close</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.close-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.close"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.close-719"><a href="#VimGolfEnv.close-719"><span class="linenos">719</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="VimGolfEnv.close-720"><a href="#VimGolfEnv.close-720"><span class="linenos">720</span></a><span class="w"> </span><span class="sd">"""Close the environment"""</span>
</span><span id="VimGolfEnv.close-721"><a href="#VimGolfEnv.close-721"><span class="linenos">721</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span><span class="p">:</span>
</span><span id="VimGolfEnv.close-722"><a href="#VimGolfEnv.close-722"><span class="linenos">722</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_closing</span> <span class="o">=</span> <span class="kc">True</span>
</span><span id="VimGolfEnv.close-723"><a href="#VimGolfEnv.close-723"><span class="linenos">723</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</span><span id="VimGolfEnv.close-724"><a href="#VimGolfEnv.close-724"><span class="linenos">724</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">_kill_docker_container</span><span class="p">()</span>
</span><span id="VimGolfEnv.close-725"><a href="#VimGolfEnv.close-725"><span class="linenos">725</span></a> <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span>
</span><span id="VimGolfEnv.close-726"><a href="#VimGolfEnv.close-726"><span class="linenos">726</span></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">):</span>
</span><span id="VimGolfEnv.close-727"><a href="#VimGolfEnv.close-727"><span class="linenos">727</span></a> <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="p">)</span>
</span><span id="VimGolfEnv.close-728"><a href="#VimGolfEnv.close-728"><span class="linenos">728</span></a> <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"executor"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
</span></pre></div>
<div class="docstring"><p>Close the environment</p>
</div>
</div>
<div id="VimGolfEnv.calculate_relative_inverse_score" class="classattr">
<input id="VimGolfEnv.calculate_relative_inverse_score-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">calculate_relative_inverse_score</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">score</span><span class="p">:</span> <span class="nb">int</span>, </span><span class="param"><span class="n">worst_score</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="VimGolfEnv.calculate_relative_inverse_score-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#VimGolfEnv.calculate_relative_inverse_score"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="VimGolfEnv.calculate_relative_inverse_score-730"><a href="#VimGolfEnv.calculate_relative_inverse_score-730"><span class="linenos">730</span></a> <span class="k">def</span><span class="w"> </span><span class="nf">calculate_relative_inverse_score</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">score</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">worst_score</span><span class="p">:</span><span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-731"><a href="#VimGolfEnv.calculate_relative_inverse_score-731"><span class="linenos">731</span></a><span class="w"> </span><span class="sd">"""Calculate the relative inverse score of the given score</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-732"><a href="#VimGolfEnv.calculate_relative_inverse_score-732"><span class="linenos">732</span></a><span class="sd"> </span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-733"><a href="#VimGolfEnv.calculate_relative_inverse_score-733"><span class="linenos">733</span></a><span class="sd"> Args:</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-734"><a href="#VimGolfEnv.calculate_relative_inverse_score-734"><span class="linenos">734</span></a><span class="sd"> score (int): The score to calculate the relative inverse score of.</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-735"><a href="#VimGolfEnv.calculate_relative_inverse_score-735"><span class="linenos">735</span></a><span class="sd"> worst_score (int, optional): The worst score to use. Defaults to None.</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-736"><a href="#VimGolfEnv.calculate_relative_inverse_score-736"><span class="linenos">736</span></a>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-737"><a href="#VimGolfEnv.calculate_relative_inverse_score-737"><span class="linenos">737</span></a><span class="sd"> Returns:</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-738"><a href="#VimGolfEnv.calculate_relative_inverse_score-738"><span class="linenos">738</span></a><span class="sd"> float: The relative inverse score.</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-739"><a href="#VimGolfEnv.calculate_relative_inverse_score-739"><span class="linenos">739</span></a><span class="sd"> """</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-740"><a href="#VimGolfEnv.calculate_relative_inverse_score-740"><span class="linenos">740</span></a> <span class="k">assert</span> <span class="n">score</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"Score must be non-negative"</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-741"><a href="#VimGolfEnv.calculate_relative_inverse_score-741"><span class="linenos">741</span></a> <span class="k">if</span> <span class="n">worst_score</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-742"><a href="#VimGolfEnv.calculate_relative_inverse_score-742"><span class="linenos">742</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_file</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-743"><a href="#VimGolfEnv.calculate_relative_inverse_score-743"><span class="linenos">743</span></a> <span class="n">worst_score</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span> <span class="o">+</span> <span class="mi">10</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-744"><a href="#VimGolfEnv.calculate_relative_inverse_score-744"><span class="linenos">744</span></a> <span class="n">ret</span> <span class="o">=</span> <span class="n">worst_score</span> <span class="o">/</span> <span class="n">score</span>
</span><span id="VimGolfEnv.calculate_relative_inverse_score-745"><a href="#VimGolfEnv.calculate_relative_inverse_score-745"><span class="linenos">745</span></a> <span class="k">return</span> <span class="n">ret</span>
</span></pre></div>
<div class="docstring"><p>Calculate the relative inverse score of the given score</p>
<h6 id="arguments">Arguments:</h6>
<ul>
<li><strong>score (int):</strong> The score to calculate the relative inverse score of.</li>
<li><strong>worst_score (int, optional):</strong> The worst score to use. Defaults to None.</li>
</ul>
<h6 id="returns">Returns:</h6>
<blockquote>
<p>float: The relative inverse score.</p>
</blockquote>
</div>
</div>
</section>
</main>
<script>
function escapeHTML(html) {
return document.createElement('div').appendChild(document.createTextNode(html)).parentNode.innerHTML;
}
const originalContent = document.querySelector("main.pdoc");
let currentContent = originalContent;
function setContent(innerHTML) {
let elem;
if (innerHTML) {
elem = document.createElement("main");
elem.classList.add("pdoc");
elem.innerHTML = innerHTML;
} else {
elem = originalContent;
}
if (currentContent !== elem) {
currentContent.replaceWith(elem);
currentContent = elem;
}
}
function getSearchTerm() {
return (new URL(window.location)).searchParams.get("search");
}
const searchBox = document.querySelector(".pdoc input[type=search]");
searchBox.addEventListener("input", function () {
let url = new URL(window.location);
if (searchBox.value.trim()) {
url.hash = "";
url.searchParams.set("search", searchBox.value);
} else {
url.searchParams.delete("search");
}
history.replaceState("", "", url.toString());
onInput();
});
window.addEventListener("popstate", onInput);
let search, searchErr;
async function initialize() {
try {
search = await new Promise((resolve, reject) => {
const script = document.createElement("script");
script.type = "text/javascript";
script.async = true;
script.onload = () => resolve(window.pdocSearch);
script.onerror = (e) => reject(e);
script.src = "../search.js";
document.getElementsByTagName("head")[0].appendChild(script);
});
} catch (e) {
console.error("Cannot fetch pdoc search index");
searchErr = "Cannot fetch search index.";
}
onInput();
document.querySelector("nav.pdoc").addEventListener("click", e => {
if (e.target.hash) {
searchBox.value = "";
searchBox.dispatchEvent(new Event("input"));
}
});
}
function onInput() {
setContent((() => {
const term = getSearchTerm();
if (!term) {
return null
}
if (searchErr) {
return `<h3>Error: ${searchErr}</h3>`
}
if (!search) {
return "<h3>Searching...</h3>"
}
window.scrollTo({top: 0, left: 0, behavior: 'auto'});
const results = search(term);
let html;
if (results.length === 0) {
html = `No search results for '${escapeHTML(term)}'.`
} else {
html = `<h4>${results.length} search result${results.length > 1 ? "s" : ""} for '${escapeHTML(term)}'.</h4>`;
}
for (let result of results.slice(0, 10)) {
let doc = result.doc;
let url = `../${doc.modulename.replaceAll(".", "/")}.html`;
if (doc.qualname) {
url += `#${doc.qualname}`;
}
let heading;
switch (result.doc.kind) {
case "function":
if (doc.fullname.endsWith(".__init__")) {
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
} else {
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
}
break;
case "class":
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
if (doc.bases)
heading += `<wbr>(<span class="base">${doc.bases}</span>)`;
heading += `:`;
break;
case "variable":
heading = `<span class="name">${doc.fullname}</span>`;
if (doc.annotation)
heading += `<span class="annotation">${doc.annotation}</span>`;
if (doc.default_value)
heading += `<span class="default_value"> = ${doc.default_value}</span>`;
break;
default:
heading = `<span class="name">${doc.fullname}</span>`;
break;
}
html += `
<section class="search-result">
<a href="${url}" class="attr ${doc.kind}">${heading}</a>
<div class="docstring">${doc.doc}</div>
</section>
`;
}
return html;
})());
}
if (getSearchTerm()) {
initialize();
searchBox.value = getSearchTerm();
onInput();
} else {
searchBox.addEventListener("focus", initialize, {once: true});
}
searchBox.addEventListener("keydown", e => {
if (["ArrowDown", "ArrowUp", "Enter"].includes(e.key)) {
let focused = currentContent.querySelector(".search-result.focused");
if (!focused) {
currentContent.querySelector(".search-result").classList.add("focused");
} else if (
e.key === "ArrowDown"
&& focused.nextElementSibling
&& focused.nextElementSibling.classList.contains("search-result")
) {
focused.classList.remove("focused");
focused.nextElementSibling.classList.add("focused");
focused.nextElementSibling.scrollIntoView({
behavior: "smooth",
block: "nearest",
inline: "nearest"
});
} else if (
e.key === "ArrowUp"
&& focused.previousElementSibling
&& focused.previousElementSibling.classList.contains("search-result")
) {
focused.classList.remove("focused");
focused.previousElementSibling.classList.add("focused");
focused.previousElementSibling.scrollIntoView({
behavior: "smooth",
block: "nearest",
inline: "nearest"
});
} else if (
e.key === "Enter"
) {
focused.querySelector("a").click();
}
}
});
</script></body>
</html>