check_meta.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "# gather all the meta info from all  the files -  check for errors \n",
    "import yaml\n",
    "from pathlib import Path"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "def extract_meta_from_qmd(file_path):\n",
    "    \"\"\"\n",
    "    Extracts and returns the YAML front matter (meta information) from a QMD file.\n",
    "    \n",
    "    Parameters:\n",
    "    - file_path: Path to the QMD file.\n",
    "    \n",
    "    Returns:\n",
    "    - A dictionary containing the parsed YAML front matter, or None if not found.\n",
    "    \"\"\"\n",
    "    # Initialize an empty string to hold the YAML content\n",
    "    yaml_content = ''\n",
    "    # Flag to indicate if we are within the YAML front matter\n",
    "    in_yaml = False\n",
    "    \n",
    "    with open(file_path, 'r') as f:\n",
    "        for line in f:\n",
    "            # Check for the start/end of the YAML front matter\n",
    "            if line.strip() == '---':\n",
    "                if in_yaml:\n",
    "                    # We found the second ---, stop reading further\n",
    "                    break\n",
    "                else:\n",
    "                    # We found the first ---, start collecting lines\n",
    "                    in_yaml = True\n",
    "            elif in_yaml:\n",
    "                # Add the current line to the YAML content\n",
    "                yaml_content += line\n",
    "    \n",
    "    # Parse the YAML content if any was found\n",
    "    if yaml_content:\n",
    "        return yaml.safe_load(yaml_content)\n",
    "    else:\n",
    "        return None\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [],
   "source": [
    "import os\n",
    "\n",
    "def list_all_files(root_dir):\n",
    "    \"\"\"List all files in a directory and its subdirectories.\"\"\"\n",
    "    all_files = []\n",
    "    for root, dirs, files in os.walk(root_dir):\n",
    "        for file in files:\n",
    "            all_files.append(os.path.join(root, file))\n",
    "    return all_files"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [],
   "source": [
    "base = Path(\"/home/norm/compiler_course_2024fa/\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "title {'Representation of programs', 'Performance and Measurement', '14_gpu_compilers', '5_hw', 'project', 'EECE7398 Fall 2024', '10 MLIR', '3_hw ', 'Untitled', '_ loop invariant code motion', '9 polyhedral analysis', '11 Whole program', 'EECS7398 Weekly Schedule', 'How to do assignments', 'homework 0', '8 classic loop optimizations', 'Overview of Bril', '_ partial_redundancy elimination', '4_hw', 'EECS7398 Weekly Schedule fa 2024', '_ local value numbering', '4. Data Flow', 'About', 'Schedule', '3 Local Analysis & Optimization', '2.hw', '12_memory.qmd', 'Testing Register allocators', '6- extra credit hw ', '1 Compiler Overview', '1-Homework', 'Static Single Assignment', '13_dynamic_compielrs', '5 Global Analysis'}\n",
      "format {'html'}\n",
      "tbl-colwidths {'10, 20, 20, 20, 15, 15'}\n",
      "format.html {'default'}\n",
      "format.revealjs {\"{'chalkboard': True, 'output-file': 'revealjs-licm', 'scrollable': True}\", \"{'chalkboard': True, 'output-file': 'revealjs-rep'}\", \"{'chalkboard': True, 'output-file': 'revealjs-partial-redun', 'scrollable': True}\", \"{'chalkboard': True, 'scrollable': True, 'output-location': 'slide', 'code-line-numbers': True, 'output-file': 'revealjs-bril'}\", \"{'chalkboard': True, 'output-file': 'revealjs-local', 'scrollable': True}\", \"{'chalkboard': True, 'output-file': 'revealjs-ssa', 'scrollable': True}\", \"{'chalkboard': True, 'output-file': 'revealjs-lvn', 'scrollable': True}\", \"{'chalkboard': True, 'output-file': 'revealjs-compiler_overview.html', 'scrollable': True}\", \"{'chalkboard': True, 'output-file': 'revealjs-data-flow', 'scrollable': True}\", \"{'chalkboard': True, 'output-file': 'revealjs-global-anal', 'scrollable': True}\", \"{'chalkboard': True, 'output-file': 'revealjs-performance.html', 'scrollable': True}\"}\n",
      "keep-ipynb {True}\n",
      "python {'kaggle_comp'}\n",
      "sidebar {False}\n",
      "execute.echo {'True'}\n"
     ]
    }
   ],
   "source": [
    "from numpy import isin\n",
    "\n",
    "\n",
    "meta_union = {}\n",
    "for file in list_all_files(base):\n",
    "    file_path = Path(file)\n",
    "    if file_path.suffix in [\".pdf\", \".jpg\", \".png\", \".woff\", \".eot\", \".woff2\", \".ttf\", \".so\", \".pyc\"]:\n",
    "        continue\n",
    "    if file_path.parent.name == \"bin\":\n",
    "        continue \n",
    "    if any(parent.name == \".venv\" for parent in file_path.parents):\n",
    "        continue\n",
    "    if any(parent.name == \".git\" for parent in file_path.parents):\n",
    "        continue\n",
    "    meta_info = extract_meta_from_qmd(file)\n",
    "    if meta_info:\n",
    "        for key, value in meta_info.items():\n",
    "    \n",
    "            if isinstance(value, list):\n",
    "                value = ', '.join(map(str, value))\n",
    "            elif isinstance(value,dict):\n",
    "                for sub_key, sub_value in value.items():\n",
    "                    combined_key = f\"{key}.{sub_key}\"  # Combine the parent key and sub-key\n",
    "                    sub_value = str(sub_value)  # Convert sub-value to string\n",
    "                    if combined_key not in meta_union:\n",
    "                        meta_union[combined_key] = {sub_value}\n",
    "                    else:\n",
    "                        meta_union[combined_key].add(sub_value)\n",
    "                continue\n",
    "            \n",
    "            if key not in meta_union:\n",
    "                meta_union[key] = {value}\n",
    "            else:\n",
    "                meta_union[key].add(value)\n",
    "\n",
    "for (k,v) in meta_union.items():\n",
    "    print (k, v )\n",
    "\n",
    "    "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 64,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "/home/norm/compiler_course_2024fa/lectures/02a_representation.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/010_compiler_overview.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/02b_bril.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/05_global.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/01a_performance_measurement.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/06_ssa.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/05b_licm.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/04_data_flow.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/03b_local_value_numbering.qmd missing chalkboard\n",
      "/home/norm/compiler_course_2024fa/lectures/03_local.qmd missing chalkboard\n"
     ]
    }
   ],
   "source": [
    "import os\n",
    "import yaml\n",
    "\n",
    "base = Path(\"/home/norm/compiler_course_2024fa/\")\n",
    "\n",
    "# Step 1: List all .qmd files\n",
    "qmd_files = []\n",
    "slide_qmd_files = []\n",
    "\n",
    "for root, dirs, files in os.walk(base):  # Adjust '.' to your project directory if necessary\n",
    "    revealjs_\n",
    "    if \"_site\" in Path(root).parts:\n",
    "        continue\n",
    "    for file in files:\n",
    "        if file.endswith('.qmd'):\n",
    "            qmd_files.append(os.path.join(root, file))\n",
    "\n",
    "# Step 2: Read and parse each .qmd file\n",
    "for qmd_file in qmd_files:\n",
    "\n",
    "    with open(qmd_file, 'r') as file:\n",
    "        content = file.read()\n",
    "        # Assuming the YAML metadata is at the top of the file, delimited by ---\n",
    "        if content.startswith('---'):\n",
    "            end_of_yaml = content.find('---', 3)\n",
    "            if end_of_yaml != -1:\n",
    "                yaml_content = content[3:end_of_yaml]\n",
    "                metadata = yaml.safe_load(yaml_content)  # Parse YAML\n",
    "\n",
    "                format_data = metadata.get('format')\n",
    "                if not format_data:\n",
    "                    print(qmd_file, \"no format field\")\n",
    "                    continue\n",
    "                try:\n",
    "                    html_meta_data = format_data.get(\"html\")\n",
    "                except Exception as e:\n",
    "                    print(qmd_file, e, 'format does not have html')\n",
    "                    continue\n",
    "\n",
    "                if html_meta_data != 'default':\n",
    "                    print(qmd_file, \"not html default\")\n",
    "                    continue \n",
    "                try:\n",
    "                    revealjs_meta_data = format_data.get('revealjs')\n",
    "                except:\n",
    "                    print(\"qmd_file\", \"no revealjs\")\n",
    "                    continue\n",
    "                if revealjs_meta_data:\n",
    "                    chalk = revealjs_meta_data.get(\"chalkboard'\")\n",
    "                    if chalk != 'true':\n",
    "                        print(qmd_file, \"missing chalkboard\")\n",
    "    \n",
    "                # get the format\n",
    "                # see if it has a subkey, revealjs\n",
    "                # if it does check for an deeper subkey of output-file\n",
    "\n",
    "                # Step 3: Check for format: reveljs\n",
    "                if metadata.get('format') == 'revealjs':\n",
    "                    # Step 4: Verify the output file name\n",
    "                    expected_output = 'reveljs-' + os.path.basename(qmd_file).replace('.qmd', '')\n",
    "                    if metadata.get('output-file') == expected_output:\n",
    "                        print(f\"{qmd_file}: Success, output file name is correct.\")\n",
    "                    else:\n",
    "                        print(f\"{qmd_file}: Failure, output file name does not match the expected '{expected_output}'.\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "kaggle_comp",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.8"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}