Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikeizbicki/html_validator


https://github.com/mikeizbicki/html_validator

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
# HTML Validation with Stacks

[![](https://github.com/mikeizbicki/html_validator/workflows/tests/badge.svg)](https://github.com/mikeizbicki/html_validator/actions?query=workflow%3Atests)

[![](https://github.com/mikeizbicki/html_validator/workflows/extra_credit/badge.svg)](https://github.com/mikeizbicki/html_validator/actions?query=workflow%3Atests)



You will implement an extended version of the balanced parentheses algorithm that checks whether html tags are balanced.

(See [chapter 4.7](https://runestone.academy/runestone/books/published/pythonds/BasicDS/BalancedSymbolsAGeneralCase.html) of the book for details on the balanced parentheses algorithm.)



**Learning Objectives:**



1. implement the balanced parenthesis algorithm

1. practice using HTML

1. practice using stacks

1. practice using pytest and test driven development



## Background



HTML is how webpages format their content.

A simple example is the following code:



```

Data structures is the best!

```



Which results in text that looks like: Data structures is the best!



The text between angle brackets is called a tag,

and tags always come in pairs.

The first tag (``) is called an opening tag and the second tag (``) is called a closing tag.

Closing tags always have the same text as an opening tag, except that a slash `/` is added at the very beginning.



There are many html tags that control different formatting options,

and they get combined in complex ways to generate the layout of webpages.

For example, the `` tag causes text to be italicized and the `` tag causes text to be underlined.

The HTML:



```

Data structures is the best!

```



results in text that looks like: Data structures is the best!



Large webpages have tens of thousands of html tags in a single file,

and it is important to verify that this html is correct.

Examples of incorrect html are:



1. `example` (there is no closing `` tag)

1. `python is  awesome ` (the `` closing tag needs to be outside of the `` tag)



The goal of this assignment is to write a program which can detect these HTML errors.



**Real World Application:**

The [World Wide Web Consortium (W3C)](https://w3.org) is the organization responsible for maintaining the HTML standard.

They have a program online at https://validator.w3.org/ which performs HTML validation,

and it is used by web developers around the world to improve their webpages.

You are implementing a limited version of this program.



## Tasks



Complete the following tasks:



1. Fork the [html\_validator repo](https://github.com/mikeizbicki/html_validator) and enable github actions

1. Update the `README.md` file so that the test case badges point to your forked repo

1. Implement the `validate_html` and `_extract_tags` functions so that all test cases in `tests/test_main.py` pass



## Extra Credit: HTML Attributes



The function of many HTML tags can be modified by specifying attributes within the opening tag.

For example:

```

This is a hyperlink to my webpage.

```

The `a` tag creates a hyperlink, and the `href` attribute specifies where the link goes.

Notice that the `href` attribute appears only in the opening tag and not in the closing tag.



The file `tests/test_ec.py` contains test cases for HTML that includes attributes.

If your code successfully passes all of these test cases, then you will get 1 point of extra credit on the assignment. 

You must pass all of the test cases and get the green extra credit badge in order to get this point.



**HINT:**

You do not need to modify the `validate_html` function at all.

Instead, just modify the `_extract_tags` function so that it ignores any attributes present in the opening tag.