add property to get webvtt content without needing a file

[DawoudSheraz]

Description

This PR adds a property content in WebVTT object to obtain the formatted vtt without the need to create a .vtt file on the system. This can be helpful in cases when the data needs to be saved on a remote server and not on the hosted server. The addition of property will remove the overhead of creating a temporary vtt file and then reading the content from it.

Unit Tests Result

[DawoudSheraz]

@glut23 Hello. Can you take a look and provide your thoughts? Thanks

[DawoudSheraz]

@glut23 Hi. Did you get a chance to look at this? Thank You

[DawoudSheraz]

@glut23 Hello. Pinging to get an update. Thank You

[glut23]

Hey @DawoudSheraz apologies for not replying earlier. Having this is indeed useful and it would be good to add it in. I would use the class WebVTTWriter to do it. Also it would be great if you could have the docs also updated to reflect this new feature.

[DawoudSheraz]

Hey @DawoudSheraz apologies for not replying earlier. Having this is indeed useful and it would be good to add it in. I would use the class WebVTTWriter to do it. Also it would be great if you could have the docs also updated to reflect this new feature.

Sure, I will update the PR and the docs and then follow-up. Thanks

[glut23]

Please use the class WebVTTWriter to do this.

[glut23]

Can you use textwrap dedent for better readability?
`
textwrap.dedent("""
WEBVTT

00:00:00.500 --> 00:00:07.000
Caption test line 1
Caption test line 2

...
""").strip()
`

[DawoudSheraz]

@glut23 Hello. I have updated the code and addressed the comments. Please take a second look. Thank You

[glut23]

To do this better create a list and add each line to it, then use '\n'.join.

[DawoudSheraz]

@glut23 If each line were separated by a single \n, it would have made sense. But there is inconsistency in the newline after WEBVTT, identifier, and timestamps. Using a list would make it a bit difficult to read and understand because of the combination of strings with \n or empty strings during appending and the last join to get the desired results. Adding one variant of code as following:

        output = ["WEBVTT"]
        for caption in captions:
            if caption.identifier:
                output.append("\n{}".format(caption.identifier))
            output.append('\n{} --> {}'.format(caption.start, caption.end))
            for line in caption.lines:
                output.append(line)
        return '\n'.join(output)

[glut23]

Hi @DawoudSheraz apologies for the late reply. That code makes the current tests to break. The \n handling in between elements is not very readable so I would just get rid of it. This is how I would do it:

    output = ['WEBVTT']
    for caption in captions:
        output.append('')
        if caption.identifier:
            output.append(caption.identifier)
        output.append('{} --> {}'.format(caption.start, caption.end))
        output.extend(caption.lines)
    return '\n'.join(output)

Also you test had an issue expecting a last blank line to be present in the resulting content. You can do this:

    expected_content = textwrap.dedent("""
            WEBVTT

            00:00:00.500 --> 00:00:07.000
            Caption test line 1
            Caption test line 2

            00:00:08.000 --> 00:00:15.000
            Caption test line 3
            Caption test line 4
            """).strip()

[glut23]

Hi @DawoudSheraz apologies for the late reply. That code makes the current tests to break. The \n handling in between elements is not very readable so I would just get rid of it. This is how I would do it:

    output = ['WEBVTT']
    for caption in captions:
        output.append('')
        if caption.identifier:
            output.append(caption.identifier)
        output.append('{} --> {}'.format(caption.start, caption.end))
        output.extend(caption.lines)
    return '\n'.join(output)

Also you test had an issue expecting a last blank line to be present in the resulting content. You can do this:

    expected_content = textwrap.dedent("""
            WEBVTT

            00:00:00.500 --> 00:00:07.000
            Caption test line 1
            Caption test line 2

            00:00:08.000 --> 00:00:15.000
            Caption test line 3
            Caption test line 4
            """).strip()

[DawoudSheraz]

@glut23 Thanks for the feedback. I have updated the code.

[glut23]

Hey @DawoudSheraz I merged the code and I will prepare a release as soon as I can. Thanks for contributing!

[DawoudSheraz]

Hey @DawoudSheraz I merged the code and I will prepare a release as soon as I can. Thanks for contributing!

Glad to hear that, thank you.

[glut23]

Hey @DawoudSheraz 0.4.6 is now released. Thanks.

[DawoudSheraz]

Awesome, thanks