…lookup failures MythTV#654

…ime field. If both are missing, avoid a crash by testing for a non-NULL episode duration. MythTV#654

… episode, and not the time. MythTV#654

…ime field. If both are missing, avoid a crash by testing for a non-NULL episode duration. MythTV#654

…rageRuntime field. If both are missing, avoid a crash by testing for a non-NULL episode duration. MythTV#654"

This reverts commit 82bad85.

I've learned that I cannot push more than one commit from one branch.

In rare cases, the TvMaze database provides null timestamp
or runtime data fields. To make the metadata retrieval script
more fault tolerant, null checks have been added for these values.

When the timestamp field is null, don't use it to generate a
datetime to use in a search for a matching episode.

When the runtime duration field is null, the delta size is
now set to zero minutes. The code which looks for an episode
match has been updated to separate "on time" recordings from
"a little late" recordings to accommodate the possible delta
size of zero.

Refs: MythTV#654

The script tvmaze/show.py had a line which retrieved the episode
duration from the metadata provider, but then assigned it to
num_episodes, which makes no sense. There is no code looking for
num_episodes, but there is code looking for runtime, so the line
has been fixed to assign to runtime.

Using the TVmaze service for metadata lookup, there are rare
cases where the 'runtime' field is empty, but 'averageRuntime'
is not. This happened when looking up metadata for a TV show
called "Everything's Trash". Note that the database entry for
this show was subsequently updated to include the missing
'runtime' field. But on the night it was recorded, and for
several days later, that field was null.

Here's an excerpt of the original metadata for "Everything's Trash":

"id":60518,
"url":"https://www.tvmaze.com/shows/60518/everythings-trash",
"name":"Everything's Trash",
"type":"Scripted",
"language":"English",
"genres":[],
"status":"Running",
"runtime":null,
"averageRuntime":30,

To handle this type of scenario, when the 'runtime' field is null,
read the duration from the 'averageRuntime' field. If both are null,
then avoid trying to cast that value to an integer in tvmaze.py.

Refs: MythTV#654

The tool pylint reported several unnecessary includes in
tvmaze.py. These have been removed to make the script run
a little bit faster.

Refs: MythTV#654

The tool pylint reported several unnecessary includes in
tvmaze.py. These have been removed to make the script run
a little bit faster.

Refs: MythTV#654

A recording of a broadcast of the first episode in
season 16 of "Criminal Minds" on CBS lead to a metadata
lookup failure. The general syntax for this metadata
lookup was:
    tvmaze.py -N "Criminal Minds" "2022-11-24 11:00:00"
Investigation revealed that for recent years this show is
normally only available on a streaming service called
Paramount+.
  https://api.tvmaze.com/shows/81
    ...
    "webChannel":{"id":107,"name":"Paramount+",
    "country":null,"officialSite":
    "https://www.paramountplus.com/"}
    ...

The null value for Country caused the Timezone
retrieval code in tvmaze.py to fail. The code has
been updated to handle a null Country field.

While regression testing, another crash appeared.
    tvmaze.py -N "The Masked Singer" "2022-11-24 19:00:00"
This show has distinct versions in many countries and
timezones.

country='United States',  timezone='America/New_York'
country='United Kingdom', timezone='Europe/London'
country='Australia',      timezone='Australia/Sydney'
country='Belgium',        timezone='Europe/Brussels'
country=None, show_tz =None  (Japanese version)
country='Finland',        timezone='Europe/Helsinki'
country='Germany',        timezone='Europe/Busingen'
country='Israel',         timezone='Asia/Jerusalem'
country='Mexico',         timezone='America/Monterrey'

The null Country field for the Japanese version is
handled fine, but passing 'Asia/Jerusalem' to
astimezone() caused it to throw an exception.

  UnboundLocalError: local variable 'ttmfmt'
  referenced before assignment

This appears to be a bug in python3. To prevent
it from crashing our script, UnboundLocalError
has been added to the exception catcher.

Some of the debug print messages have also been
updated to improve their format.

Refs: MythTV#654

The previous commit added an exception catch for
UnboundLocalError because regression testing
revealed a failure in handling the Asia/Jerusalem
timezone. This timezone uses the version 3 data
format. A new issue MythTV#672 was opened to ask for
support for version 3. Since that issue has now
been fixed, we no longer need to catch
UnboundLocalError.

Refs: MythTV#654

When using tvmaze.py to retrieve Collection information, the
runtime information was not being displayed. This update adds
it to output. For example, the Collection information for
the TV show "Hogan's Heroes" is now:

/usr/share/mythtv/metadata/Television/tvmaze.py -C 1475
<?xml version='1.0' encoding='UTF-8'?>
<metadata>
  <item>
    <title>Hogan's Heroes</title>
...
    <inetref>1475</inetref>
    <imdb>tt0058812</imdb>
    <collectionref>1475</collectionref>
    <language>en</language>
    <releasedate>1965-09-17</releasedate>
    <userrating>8.000000</userrating>
    <popularity>85.0</popularity>
    <year>1965</year>
    <runtime>30</runtime>
...
  </item>
</metadata>

Refs: MythTV#654

The tool pylint reported several unnecessary includes in
tvmaze.py. These have been removed to make the script run
a little bit faster.

Refs: #654

The script tvmaze/show.py had a line which retrieved the episode
duration from the metadata provider, but then assigned it to
num_episodes, which makes no sense. There is no code looking for
num_episodes, but there is code looking for runtime, so the line
has been fixed to assign to runtime.

Using the TVmaze service for metadata lookup, there are rare
cases where the 'runtime' field is empty, but 'averageRuntime'
is not. This happened when looking up metadata for a TV show
called "Everything's Trash". Note that the database entry for
this show was subsequently updated to include the missing
'runtime' field. But on the night it was recorded, and for
several days later, that field was null.

Here's an excerpt of the original metadata for "Everything's Trash":

"id":60518,
"url":"https://www.tvmaze.com/shows/60518/everythings-trash",
"name":"Everything's Trash",
"type":"Scripted",
"language":"English",
"genres":[],
"status":"Running",
"runtime":null,
"averageRuntime":30,

To handle this type of scenario, when the 'runtime' field is null,
read the duration from the 'averageRuntime' field. If both are null,
then avoid trying to cast that value to an integer in tvmaze.py.

Refs: #654

When using tvmaze.py to retrieve Collection information, the
runtime information was not being displayed. This update adds
it to output. For example, the Collection information for
the TV show "Hogan's Heroes" is now:

/usr/share/mythtv/metadata/Television/tvmaze.py -C 1475
<?xml version='1.0' encoding='UTF-8'?>
<metadata>
  <item>
    <title>Hogan's Heroes</title>
...
    <inetref>1475</inetref>
    <imdb>tt0058812</imdb>
    <collectionref>1475</collectionref>
    <language>en</language>
    <releasedate>1965-09-17</releasedate>
    <userrating>8.000000</userrating>
    <popularity>85.0</popularity>
    <year>1965</year>
    <runtime>30</runtime>
...
  </item>
</metadata>

Refs: #654

In rare cases, the TvMaze database provides null timestamp
or runtime data fields. To make the metadata retrieval script
more fault tolerant, null checks have been added for these values.

When the timestamp field is null, don't use it to generate a
datetime to use in a search for a matching episode.

When the runtime duration field is null, the delta size is
now set to zero minutes. The code which looks for an episode
match has been updated to separate "on time" recordings from
"a little late" recordings to accommodate the possible delta
size of zero.

Refs: #654

A recording of a broadcast of the first episode in
season 16 of "Criminal Minds" on CBS lead to a metadata
lookup failure. The general syntax for this metadata
lookup was:
    tvmaze.py -N "Criminal Minds" "2022-11-24 11:00:00"
Investigation revealed that for recent years this show is
normally only available on a streaming service called
Paramount+.
  https://api.tvmaze.com/shows/81
    ...
    "webChannel":{"id":107,"name":"Paramount+",
    "country":null,"officialSite":
    "https://www.paramountplus.com/"}
    ...

The null value for Country caused the Timezone
retrieval code in tvmaze.py to fail. The code has
been updated to handle a null Country field.

While regression testing, another crash appeared.
    tvmaze.py -N "The Masked Singer" "2022-11-24 19:00:00"
This show has distinct versions in many countries and
timezones.

country='United States',  timezone='America/New_York'
country='United Kingdom', timezone='Europe/London'
country='Australia',      timezone='Australia/Sydney'
country='Belgium',        timezone='Europe/Brussels'
country=None, show_tz =None  (Japanese version)
country='Finland',        timezone='Europe/Helsinki'
country='Germany',        timezone='Europe/Busingen'
country='Israel',         timezone='Asia/Jerusalem'
country='Mexico',         timezone='America/Monterrey'

The null Country field for the Japanese version is
handled fine, but passing 'Asia/Jerusalem' to
astimezone() caused it to throw an exception.

  UnboundLocalError: local variable 'ttmfmt'
  referenced before assignment

This appears to be a bug in python3. To prevent
it from crashing our script, UnboundLocalError
has been added to the exception catcher.

Some of the debug print messages have also been
updated to improve their format.

Refs: #654

The previous commit added an exception catch for
UnboundLocalError because regression testing
revealed a failure in handling the Asia/Jerusalem
timezone. This timezone uses the version 3 data
format. A new issue #672 was opened to ask for
support for version 3. Since that issue has now
been fixed, we no longer need to catch
UnboundLocalError.

Refs: #654

Sometimes, the TvMaze database only specifies a date
and not a time for an episode or set of episodes.
This is most common in webChannel originated shows.
In such a case, the 'Find Episode by Timestamp'
syntax, fails to find an exact or close match.
For example:
   tvmaze.py -N "Criminal Minds" "2022-11-24 21:00:00"

For this episode, in the TvMaze database
        airtime =
        airdate = 2022-11-24

With this code update, we detect when no airtime is
specified in the database, and apply a match-by-date
behavior.

The match-by-date results are only used as a last
resort. First we select exact timestamp matches.
If there are none of those, we select close
timestamp matches. If there are none of those,
then we'll select date only matches.

For example:

tvmaze.py -N "Criminal Minds" "2022-11-24 21:00:00"
<?xml version='1.0' encoding='UTF-8'?>
<metadata>
  <item>
    <title>Criminal Minds</title>
    <subtitle>Just Getting Started</subtitle>
    ...
    <season>16</season>
    <episode>1</episode>
    <inetref>81</inetref>
    ...
  </item>
  <item>
    <title>Criminal Minds</title>
    <subtitle>Sicarius</subtitle>
    ...
    <season>16</season>
    <episode>2</episode>
    <inetref>81</inetref>
    ...
  </item>
</metadata>

Note that there were 2 episodes released on 2022-11-24,
so both episodes appear in the output results.

In addition, a display of 'runtime' has been added
for the -M invocation option. For example

tvmaze.py -M "Fire Country"
<?xml version='1.0' encoding='UTF-8'?>
<metadata>
  <item>
    <title>Fire Country</title>
    ...
    <inetref>60339</inetref>
    <collectionref>60339</collectionref>
    <language>en</language>
    <releasedate>2022-10-07</releasedate>
    <userrating>6.300000</userrating>
    <popularity>99.0</popularity>
    <year>2022</year>
    <runtime>60</runtime>
    ...
  </item>
</metadata>

Resolves MythTV#654